svn commit: r979824 - /maven/plugins/trunk/maven-jar-plugin/src/site/apt/usage.apt.vm

[be...@apache.org]

Author: bentmann
Date: Tue Jul 27 19:37:45 2010
New Revision: 979824

URL: http://svn.apache.org/viewvc?rev=979824&view=rev
Log:
[MJAR-127] Deprecate jarsigner related goals in favor of dedicated maven-jarsigner-plugin

o Cleaned up documentation

Modified:
    maven/plugins/trunk/maven-jar-plugin/src/site/apt/usage.apt.vm

Modified: maven/plugins/trunk/maven-jar-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jar-plugin/src/site/apt/usage.apt.vm?rev=979824&r1=979823&r2=979824&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jar-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-jar-plugin/src/site/apt/usage.apt.vm Tue Jul 27 19:37:45 2010
@@ -33,6 +33,10 @@ Usage
  configurations you should have a look at the documentation for
  {{{http://maven.apache.org/shared/maven-archiver/}Maven Archiver}}.
 
+  Note: Originally, this plugin was meant to sign JARs as well. As of version 2.3, the corresponding goals are no
+  longer supported and users are advised to use the dedicated
+  {{{http://maven.apache.org/plugins/maven-jarsigner-plugin/}Maven Jarsigner Plugin}} instead.
+
 * How to build a jar file
 
   If the packaging of your project is set to 'jar', this plugin is executed
@@ -45,70 +49,6 @@ mvn package
 
   In your project's <<<target>>> directory you'll able to see the generated jar file.
 
-
-* How to sign a jar file
-
-  If you need to sign your jar, you just need to configure
-  the sign goal appropriately in your <<<pom.xml>>>, for the signing to occur
-  automatically during the package phase.
-
-  Note that you can automatically verify a jar after signing it.
-
-+-----------------+
-<project>
-  ...
-  <packaging>jar</packaging>
-  ...
-  <build>
-    <plugins>
-      ...
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-jar-plugin</artifactId>
-        <version>${project.version}</version>
-        <executions>
-          <execution>
-            <goals>
-              <goal>sign</goal>
-            </goals>
-          </execution>
-        </executions>
-        <configuration>
-          <keystore>/path/to/your/keystore</keystore>
-          <alias>youralias</alias>
-          <storepass>yourstorepassword</storepass>
-          <signedjar>\${project.build.directory}/signed/\${project.build.finalName}.jar</signedjar>
-          <verify>true</verify>
-        </configuration>
-      </plugin>
-      ...
-    </plugins>
-  </build>
-  ...
-</project>
-+-----------------+
-
-  If you do not specify the <<<\<signedjar\>>>> file, your jar will be signed in-place.
-  If you do specify it, the plugin will attempt to create the resulting containing directory.
-
-* How to sign a jar file specifying parameters on the command line
-
-+-----------------+
-mvn jar:sign -Dkeystore=/path/to/your/keystore -Dstorepass=yourstorepassword -Dalias=youralias
-+-----------------+
-
-* How to verify a signed jar file specifying parameters on the command line
-
-+-----------------+
-mvn jar:sign-verify [-Djarpath=/path/to/your/signedjar] [-Dverbose=true [-Dcheckcerts=true] ]
-+-----------------+
-
-* How to disable jar signing
-
-+-----------------+
-mvn ... -Dmaven.jar.skip.sign=true
-+-----------------+
-
 * How to include/exclude content from jar artifact
 
   Specify a list of fileset patterns to be included or excluded by adding