You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ar...@apache.org on 2006/08/01 11:02:25 UTC
svn commit: r427494 - in /maven/plugins/trunk/maven-install-plugin/src:
main/java/org/apache/maven/plugin/install/ site/ site/apt/
site/apt/examples/ site/fml/
Author: aramirez
Date: Tue Aug 1 02:02:24 2006
New Revision: 427494
URL: http://svn.apache.org/viewvc?rev=427494&view=rev
Log:
PR: MINSTALL-27
-added license header in the documents
-added descriptions in some parameters
Modified:
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/update-release-info.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-install-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-install-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java (original)
+++ maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/AbstractInstallMojo.java Tue Aug 1 02:02:24 2006
@@ -53,6 +53,8 @@
protected ArtifactRepository localRepository;
/**
+ * Used to get the checksum of a file.
+ *
* @component role="org.apache.maven.repository.digest.Digester"
*/
private Digester digester;
Modified: maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java (original)
+++ maven/plugins/trunk/maven-install-plugin/src/main/java/org/apache/maven/plugin/install/InstallFileMojo.java Tue Aug 1 02:02:24 2006
@@ -110,6 +110,8 @@
private boolean generatePom;
/**
+ * Used to create artifacts
+ *
* @component
*/
private ArtifactFactory artifactFactory;
Modified: maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/custom-pom-installation.apt Tue Aug 1 02:02:24 2006
@@ -6,6 +6,23 @@
June 2006
------
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
Install an artifact with a custom POM
The install plugin can include a pre-built custom POM with the artifact
Modified: maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/generic-pom-generation.apt Tue Aug 1 02:02:24 2006
@@ -6,6 +6,23 @@
June 2006
------
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
Generate a generic POM
There are times when you do not have a POM for a 3rd party artifact.
Modified: maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/installing-checksums.apt Tue Aug 1 02:02:24 2006
@@ -6,6 +6,23 @@
July 2006
------
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
Creating artifact checksums
The install plugin can create integrity checksums (MD5, SHA-1)
Modified: maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/update-release-info.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/update-release-info.apt?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/update-release-info.apt (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/examples/update-release-info.apt Tue Aug 1 02:02:24 2006
@@ -6,6 +6,23 @@
July 2006
------
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
Update the release information of a project
Updating the release information means that a forced update of the project's
Modified: maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/index.apt Tue Aug 1 02:02:24 2006
@@ -6,6 +6,23 @@
July 2006
------
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
Maven Install Plugin
The Local Repository is the local cache where
@@ -38,4 +55,15 @@
* Examples
- Sample use-cases for the plugin are available under the Examples menu.
+ To provide you with better understanding on some usages of the Maven Install Plugin,
+ you can take a look into the following examples:
+
+ * {{{examples/custom-pom-installation.html}Custom POM}}
+
+ * {{{examples/generic-pom-generation.html}Generic POM}}
+
+ * {{{examples/installing-checksums.html}Installing Checksums}}
+
+ * {{{examples/update-release-info.html}Updating Release Info}}
+
+ []
Modified: maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/apt/usage.apt Tue Aug 1 02:02:24 2006
@@ -6,6 +6,23 @@
July 2006
------
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
Usage
* The <<<install:install>>> Mojo
Modified: maven/plugins/trunk/maven-install-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/fml/faq.fml?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/fml/faq.fml Tue Aug 1 02:02:24 2006
@@ -1,4 +1,21 @@
<?xml version="1.0"?>
+
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
<faqs id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="question">
@@ -11,4 +28,4 @@
</answer>
</faq>
</part>
-</faqs>
\ No newline at end of file
+</faqs>
Modified: maven/plugins/trunk/maven-install-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-install-plugin/src/site/site.xml?rev=427494&r1=427493&r2=427494&view=diff
==============================================================================
--- maven/plugins/trunk/maven-install-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-install-plugin/src/site/site.xml Tue Aug 1 02:02:24 2006
@@ -1,5 +1,21 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ ~ Copyright 2006 The Apache Software Foundation.
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+
<project name="Maven Install Plugin">
<bannerLeft>
<name>Maven Install Plugin</name>
@@ -11,7 +27,7 @@
</bannerRight>
<body>
<links>
- <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+ <item name="Maven" href="http://maven.apache.org/maven2/"/>
</links>
<menu name="Overview">