From 9850abeaea4e2e7ec9f7b46956b94228c790b54f Mon Sep 17 00:00:00 2001 From: ltheussl Date: Thu, 15 Dec 2005 01:03:51 +0000 Subject: [PATCH] PR: MPJAR-35 Submitted by: Dennis Lundberg Document need for jar.manifest.classpath property git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@356963 13f79535-47bb-0310-9956-ffa450edef68 --- jar/xdocs/changes.xml | 1 + jar/xdocs/goals.xml | 23 +++++-------------- jar/xdocs/properties.xml | 48 ++++++++++++++++++++++------------------ 3 files changed, 32 insertions(+), 40 deletions(-) diff --git a/jar/xdocs/changes.xml b/jar/xdocs/changes.xml index 3076fb49..aa0a2e38 100644 --- a/jar/xdocs/changes.xml +++ b/jar/xdocs/changes.xml @@ -25,6 +25,7 @@ + Document need for jar.manifest.classpath property. Update dependencies to match ones in maven 1.1 core and to unify them between plugins. The following dependencies are updated :
  • velocity v 1.4-dev -> v1.4
    • diff --git a/jar/xdocs/goals.xml b/jar/xdocs/goals.xml index e97eb73f..6d81ffa0 100644 --- a/jar/xdocs/goals.xml +++ b/jar/xdocs/goals.xml @@ -62,44 +62,31 @@ jar:deploy-snapshot - Deploy a snapshot jar to the remote repository + Deploy a snapshot jar to the remote repository. jar:deploy Deploy a jar to the remote repository. The jar is built using - the java:jar goal + the jar:jar goal. jar:install Install a jar into the local repository. The jar is built using - the java:jar goal + the jar:jar goal. jar:install-snapshot - Install a jar into the local repository. The jar is built using - the jar:snapshot goal and copied into the local + Install a snapshot into the local repository. The jar is built using + the jar:jar goal and copied into the local repository as the -SNAPSHOT version. - - clean - - This goal is a shortcut to the clean:clean goal - - - - clean:clean - - Removes the maven.build.dir and - maven.test.reportsDirectory directories - - diff --git a/jar/xdocs/properties.xml b/jar/xdocs/properties.xml index 2831c93c..0aa73bd3 100644 --- a/jar/xdocs/properties.xml +++ b/jar/xdocs/properties.xml @@ -51,7 +51,7 @@ section of your project descriptor. If there are includes or excludes - elements, this property will be set to true + elements, this property will be set to true. @@ -60,7 +60,7 @@ Specifies a list of patterns to exclude from the jar process. The default value is **/package.html, and is used - by the "java:jar" goal. + by the jar:jar goal. @@ -68,7 +68,7 @@ Yes Specifies a list of patterns to include with the jar process. - The default value is null + The default value is null. @@ -76,7 +76,7 @@ Yes Whether the source should be included in the jar. - The default value is false + The default value is false. @@ -101,18 +101,21 @@ maven.jar.manifest.classpath.add Yes - 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 true to enable classpath information. + Only the dependency jars that have the property + jar.manifest.classpath set to true + will be added to the classpath information. maven.jar.manifest.extensions.add Yes - 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 true to enable extension information. @@ -120,7 +123,7 @@ Yes 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. @@ -145,20 +148,20 @@ ]]> section of your - project descriptor + project descriptor. maven.jar.compress Yes - Not only store data but also compress them, defaults to true. + Not only store data but also compress them, defaults to true. maven.jar.source.path Yes The location of the source code within the jar, if included. - The default value is src + The default value is src. @@ -170,36 +173,37 @@ maven.repo.central Yes - Central repository for maven artifacts + Central repository for maven artifacts. maven.repo.central.directory Yes - Directory to deploy jars into on the remote repository + Directory to deploy jars into on the remote repository. maven.repo.local Yes - The local repository to store maven artifacts, including jar file - dependencies + The local repository to store maven artifacts, including jar file + dependencies. maven.username Yes - 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. maven.remote.group Yes - 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 maven. @@ -210,7 +214,7 @@ maven.build.dest Yes - The directory for compiled classes + The directory for compiled classes. maven.build.dir @@ -230,7 +234,7 @@ This property holds the Ant path of all the dependent jar files listed in the dependencies block of your - project descriptor + project descriptor. @@ -238,14 +242,14 @@ Yes Usually this property is set to ${pom.artifactId}-${pom.currentVersion} - but the snapshot goal overwrites it to be the snapshot signature + but the snapshot goal overwrites it to be the snapshot signature. user.name Yes - Used by the java:jar goal as the default value of the + Used by the jar:jar goal as the default value of the Built-By attribute of the manifest if one is not specified.