You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by lt...@apache.org on 2005/12/15 02:03:54 UTC

svn commit: r356963 - in /maven/maven-1/plugins/trunk/jar/xdocs: changes.xml goals.xml properties.xml

Author: ltheussl
Date: Wed Dec 14 17:03:51 2005
New Revision: 356963

URL: http://svn.apache.org/viewcvs?rev=356963&view=rev
Log:
PR: MPJAR-35
Submitted by: Dennis Lundberg
Document need for jar.manifest.classpath property

Modified:
    maven/maven-1/plugins/trunk/jar/xdocs/changes.xml
    maven/maven-1/plugins/trunk/jar/xdocs/goals.xml
    maven/maven-1/plugins/trunk/jar/xdocs/properties.xml

Modified: maven/maven-1/plugins/trunk/jar/xdocs/changes.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/jar/xdocs/changes.xml?rev=356963&r1=356962&r2=356963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/jar/xdocs/changes.xml (original)
+++ maven/maven-1/plugins/trunk/jar/xdocs/changes.xml Wed Dec 14 17:03:51 2005
@@ -25,6 +25,7 @@
   </properties>
   <body>
     <release version="1.8-SNAPSHOT" date="In SVN">
+      <action dev="ltheussl" type="update" issue="MPJAR-35" due-to="Dennis Lundberg">Document need for jar.manifest.classpath property.</action>
       <action dev="aheritier" type="update" issue="MAVEN-1712">Update dependencies to match ones in maven 1.1 core and to unify them between plugins. The following dependencies are updated : 
         <ul>
           <li>velocity v 1.4-dev -> v1.4</li>

Modified: maven/maven-1/plugins/trunk/jar/xdocs/goals.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/jar/xdocs/goals.xml?rev=356963&r1=356962&r2=356963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/jar/xdocs/goals.xml (original)
+++ maven/maven-1/plugins/trunk/jar/xdocs/goals.xml Wed Dec 14 17:03:51 2005
@@ -62,42 +62,29 @@
         <tr>
           <td>jar:deploy-snapshot</td>
           <td>
-            Deploy a snapshot jar to the remote repository
+            Deploy a snapshot jar to the remote repository.
           </td>
         </tr>
         <tr>
           <td>jar:deploy</td>
           <td>
             Deploy a jar to the remote repository. The jar is built using
-            the <code>java:jar</code> goal
+            the <code>jar:jar</code> goal.
           </td>
         </tr>
         <tr>
           <td>jar:install</td>
           <td>
             Install a jar into the local repository. The jar is built using
-            the <code>java:jar</code> goal
+            the <code>jar:jar</code> goal.
           </td>
         </tr>
         <tr>
           <td>jar:install-snapshot</td>
           <td>
-            Install a jar into the local repository. The jar is built using
-            the <code>jar:snapshot</code> goal and copied into the local
+            Install a snapshot into the local repository. The jar is built using
+            the <code>jar:jar</code> goal and copied into the local
             repository as the -SNAPSHOT version.
-          </td>
-        </tr>
-        <tr>
-          <td>clean</td>
-          <td>
-            This goal is a shortcut to the <code>clean:clean</code> goal
-          </td>
-        </tr>
-        <tr>
-          <td>clean:clean</td>
-          <td>
-            Removes the <a href="properties.html">maven.build.dir</a> and 
-            <a href="properties.html">maven.test.reportsDirectory</a> directories
           </td>
         </tr>
       </table>

Modified: maven/maven-1/plugins/trunk/jar/xdocs/properties.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/jar/xdocs/properties.xml?rev=356963&r1=356962&r2=356963&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/jar/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/trunk/jar/xdocs/properties.xml Wed Dec 14 17:03:51 2005
@@ -51,7 +51,7 @@
            section of your 
            <a href="http://maven.apache.org/reference/project-descriptor.html">
            project descriptor</a>. If there are <code>includes</code> or <code>excludes</code>
-           elements, this property will be set to true
+           elements, this property will be set to <code>true</code>.
           </td>
         </tr>
         <tr>
@@ -60,7 +60,7 @@
           <td>
             Specifies a list of patterns to exclude from the jar process.
             The default value is <code>**/package.html</code>, and is used
-            by the "java:jar" goal.
+            by the <code>jar:jar</code> goal.
           </td>
         </tr>
         <tr>
@@ -68,7 +68,7 @@
           <td>Yes</td>
           <td>
             Specifies a list of patterns to include with the jar process.
-            The default value is <code>null</code>
+            The default value is <code>null</code>.
           </td>
         </tr>
         <tr>
@@ -76,7 +76,7 @@
           <td>Yes</td>
           <td>
             Whether the source should be included in the jar.
-            The default value is <code>false</code>
+            The default value is <code>false</code>.
           </td>
         </tr>
         <tr>
@@ -101,18 +101,21 @@
           <td>maven.jar.manifest.classpath.add</td>
           <td>Yes</td>
           <td>
-            Tells maven to add classpath information the the jar manifest.
+            Tells Maven to add classpath information to the jar manifest.
             This can cause some applications to break, so it has been disabled by default.
-            Set to 'true' to enable classpath information.
+            Set to <code>true</code> to enable classpath information.
+            Only the dependency jars that have the property
+            <code>jar.manifest.classpath</code> set to <code>true</code>
+            will be added to the classpath information.
           </td>
         </tr>
         <tr>
           <td>maven.jar.manifest.extensions.add</td>
           <td>Yes</td>
           <td>
-            Tells maven to add extension information the the jar manifest.
+            Tells Maven to add extension information to the jar manifest.
             This can cause some applications to break, so it has been disabled by default.
-            Set to 'true' to enable extension information.
+            Set to <code>true</code> to enable extension information.
           </td>
         </tr>
         <tr>
@@ -120,7 +123,7 @@
           <td>Yes</td>
           <td>
             Specifies the Main-Class attribute for your manifest. If not set,
-            no MainClass attribute will be added to the manifest.
+            no Main-Class attribute will be added to the manifest.
           </td>
         </tr>
         <tr>
@@ -145,20 +148,20 @@
 ]]></source>
             section of your
             <a href="http://maven.apache.org/reference/project-descriptor.html">
-            project descriptor</a>
+            project descriptor</a>.
           </td>
         </tr>
         <tr>
 		  <td>maven.jar.compress</td>
 		  <td>Yes</td>
-		  <td>Not only store data but also compress them, defaults to true.</td>
+		  <td>Not only store data but also compress them, defaults to <code>true</code>.</td>
         </tr>
         <tr>
           <td>maven.jar.source.path</td>
           <td>Yes</td>
           <td>
             The location of the source code within the jar, if included.
-            The default value is <code>src</code>
+            The default value is <code>src</code>.
           </td>
         </tr>
       </table>
@@ -170,36 +173,37 @@
           <td>maven.repo.central</td>
           <td>Yes</td>
           <td>
-            Central repository for maven artifacts
+            Central repository for maven artifacts.
           </td>
         </tr>
         <tr>
           <td>maven.repo.central.directory</td>
           <td>Yes</td>
           <td>
-            Directory to deploy jars into on the remote repository
+            Directory to deploy jars into on the remote repository.
           </td>
         </tr>
         <tr>
           <td>maven.repo.local</td>
           <td>Yes</td>
           <td>
-            The local repository to store maven artifacts, including jar file 
-            dependencies
+            The local repository to store maven artifacts, including jar file
+            dependencies.
           </td>
         </tr>
         <tr>
           <td>maven.username</td>
           <td>Yes</td>
           <td>
-            This is the user name used to log in to the remote repository
+            This is the user name used to log in to the remote repository.
           </td>
         </tr>
         <tr>
           <td>maven.remote.group</td>
           <td>Yes</td>
           <td>
-            The name of the Unix group that should own deployed artifacts. Default to maven
+            The name of the Unix group that should own deployed artifacts.
+            Default to <code>maven</code>.
           </td>
         </tr>
       </table>
@@ -210,7 +214,7 @@
         <tr>
           <td>maven.build.dest</td>
           <td>Yes</td>
-          <td>The directory for compiled classes</td>
+          <td>The directory for compiled classes</td>.
         </tr>
         <tr>
           <td>maven.build.dir</td>
@@ -230,7 +234,7 @@
             This property holds the Ant <code>path</code> of all the dependent jar
             files listed in the <code>dependencies</code> block of your 
             <a href="http://maven.apache.org/reference/project-descriptor.html">
-            project descriptor</a>
+            project descriptor</a>.
           </td>
         </tr>
         <tr>
@@ -238,14 +242,14 @@
           <td>Yes</td>
           <td>
             Usually this property is set to <code>${pom.artifactId}-${pom.currentVersion}</code>
-            but the snapshot goal overwrites it to be the snapshot signature
+            but the snapshot goal overwrites it to be the snapshot signature.
           </td>
         </tr>
         <tr>
           <td>user.name</td>
           <td>Yes</td>
           <td>
-            Used by the <code>java:jar</code> goal as the default value of the
+            Used by the <code>jar:jar</code> goal as the default value of the
             <code>Built-By</code> attribute of the manifest if one is not specified.
           </td>
         </tr>