svn commit: r668741 - in /maven/plugins/trunk/maven-repository-plugin/src/site: apt/index.apt apt/usage.apt fml/faq.fml

[de...@apache.org]

Author: dennisl
Date: Tue Jun 17 09:47:17 2008
New Revision: 668741

URL: http://svn.apache.org/viewvc?rev=668741&view=rev
Log:
o Add docs about the bundle-pack goal.

Modified:
    maven/plugins/trunk/maven-repository-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt
    maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml

Modified: maven/plugins/trunk/maven-repository-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/site/apt/index.apt?rev=668741&r1=668740&r2=668741&view=diff
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-repository-plugin/src/site/apt/index.apt Tue Jun 17 09:47:17 2008
@@ -36,6 +36,8 @@
 
   * {{{bundle-create-mojo.html}repository:bundle-create}} Creates an upload bundle for a project built with Maven.
 
+  * {{{bundle-pack-mojo.html}repository:bundle-pack}} Creates an upload bundle for an artifact that exists in your local repository.
+
   []
 
 * Usage

Modified: maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt?rev=668741&r1=668740&r2=668741&view=diff
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-repository-plugin/src/site/apt/usage.apt Tue Jun 17 09:47:17 2008
@@ -29,9 +29,36 @@
 
 Usage
 
-* Create an upload bundle
+ This plugin helps you to create upload bundles for the central repository. A
+ bundle that will be uploaded to the central repository has to follow certain
+ requirements when it comes to the POM. Therefor all goals in this plugin will
+ check that the POM includes at least the following required elements:
 
- You can use the <<<repository:bundle-create>>> goal to create an upload bundle:
+ * modelVersion
+
+ * groupId
+
+ * artifactId
+
+ * packaging
+
+ * name
+
+ * version
+
+ * description
+
+ * url
+
+ * licenses
+
+ []
+
+
+* Create an upload bundle for a Maven project
+
+ You can use the <<<repository:bundle-create>>> goal to create an upload bundle
+ for a Maven project:
 
 +----+
 mvn repository:bundle-create
@@ -49,6 +76,24 @@
 
 +----+
 
- <<Note:>> Due to {{{http://jira.codehaus.org/browse/MREPOSITORY-11}a bug}}
- you will need to manually add the javadoc jar to the bundle jar, using zip or
- any other compression program.
+ <<Note:>> There was a bug that required you to manually add the javadoc jar to
+ the bundle jar in version 2.0 of the plugin. This has been fixed in the 2.1
+ version of the plugin.
+
+
+* Create a bundle for a non-Maven project
+
+ The <<<repository:bundle-pack>>> goal is useful if you have artifacts available
+ in your local repository that you want to create a bundle from, for an upload
+ request. It requires that the artifact has a POM in the local repository. It
+ will check for required elements, asking interactively for any missing values.
+
+ <<Note:>> This goal was introduced in version 2.1 of this plugin.
+
+ Simply run this command and follow the instructions on the command line. The
+ bundle will be created in the current directory, unless you specify
+ {{{bundle-pack-mojo.html}something else}}.
+
++----+
+mvn repository:bundle-pack
++----+

Modified: maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml?rev=668741&r1=668740&r2=668741&view=diff
==============================================================================
--- maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-repository-plugin/src/site/fml/faq.fml Tue Jun 17 09:47:17 2008
@@ -31,7 +31,6 @@
         </source>
       </answer>
     </faq>
-<!--
     <faq id="bundle-pack">
       <question>How can I create an upload bundle for a project that I don't build using maven?</question>
       <answer>
@@ -42,6 +41,5 @@
         </p>
       </answer>
     </faq>
--->
   </part>
 </faqs>