diff --git a/src/site/apt/examples/create-test-jar.apt.vm b/src/site/apt/examples/create-test-jar.apt.vm index 2bee6f8a..15463a40 100644 --- a/src/site/apt/examples/create-test-jar.apt.vm +++ b/src/site/apt/examples/create-test-jar.apt.vm @@ -31,7 +31,7 @@ How to create a jar containing test classes When you want to create a jar containing , you would probably want to reuse those classes. There are two ways to solve this: - * Create an attached jar with the from the current project and loose its transitive <<>>-scoped dependencies. + * Create an attached jar with the from the current project and lose its transitive <<>>-scoped dependencies. * Create a separate project with the . @@ -66,7 +66,7 @@ How to create a jar containing test classes +-----------------+ - To reuse this artifact in an other project, you must declare this dependency with type test-jar : + To reuse this artifact in another project, you must declare this dependency with type test-jar : +-----------------+ @@ -85,12 +85,12 @@ How to create a jar containing test classes +-----------------+ - Based on such configuration there will be two jar files generated. The first one contains the + Based on such configuration, two jar files will be generated. The first one contains the classes from <<>> whereas the second one will contain the classes from <<>>. The generated jar files follow the naming schema <<>> for the first one and - <<>> for the second one. The parts <<>>, <<>> - will be replaced by the values given within your project <<>> file. The <<>> - will be set to <<>> which is a default of the maven-jar-plugin which can be changed if you need by + <<>> for the second one. The <<>> and <<>> + will be replaced by the values given within the project's <<>> file. The <<>> + will be set to <<>> which is a default of the maven-jar-plugin and can be changed if needed by {{{../test-jar-mojo.html}using the configuration in the jar goal}}. <> The downside of this solution is that you don't get the transitive <<>>-scoped dependencies automatically. @@ -98,7 +98,7 @@ How to create a jar containing test classes * The preferred way - In order to let Maven resolve all <<>>-scoped transitive dependencies you should create a separate project. + In order to let Maven resolve all <<>>-scoped transitive dependencies, you should create a separate project. +-----------------+ diff --git a/src/site/apt/examples/manifest-customization.apt.vm b/src/site/apt/examples/manifest-customization.apt.vm index 9adc2066..cac9b0a8 100644 --- a/src/site/apt/examples/manifest-customization.apt.vm +++ b/src/site/apt/examples/manifest-customization.apt.vm @@ -30,16 +30,16 @@ Manifest customization * The Default Manifest - The default contents of the manifest is described in the documentation for + The default contents of the manifest are described in the documentation for {{{/shared/maven-archiver/examples/manifest.html}Maven Archiver}}. Starting with version 2.1, the maven-jar-plugin uses Maven Archiver ${mavenArchiverVersion}. This means that it no longer creates the Specification and Implementation details in the manifest by default. If you want them you have to say so explicitly in - your plugin configuration. This is also is described in the documentation for + your plugin configuration. This is also described in the documentation for {{{/shared/maven-archiver/examples/manifest.html}Maven Archiver}}. -* Customization the Manifest +* Customizing the Manifest The default manifest can be altered with the <<>> configuration element. Below you will find some of the configuration options that are diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index 7cedcd4b..10280838 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -34,9 +34,9 @@ ${project.name} * Goals Overview - * {{{./jar-mojo.html}jar:jar}} create a jar file for your project classes inclusive resources. + * {{{./jar-mojo.html}jar:jar}} create a jar file for your project classes including resources. - * {{{./test-jar-mojo.html}jar:test-jar}} create a jar file for your project test classes . + * {{{./test-jar-mojo.html}jar:test-jar}} create a jar file for your project test classes. * Usage @@ -55,7 +55,7 @@ ${project.name} entire debug logs, POMs, or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are welcome, too. Contributors can check out the project from our {{{./scm.html}source repository}} and will find supplementary information in the - {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}. + {{{https://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}. * Archiver Configuration diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm index ee7284b8..811e415e 100644 --- a/src/site/apt/usage.apt.vm +++ b/src/site/apt/usage.apt.vm @@ -31,16 +31,14 @@ Usage - Some brief examples on how to use this plugin. If you want to use advanced - configurations you should have a look at the + Some brief examples of how to use this plugin. If you want to use advanced + configurations, you should have a look at the {{{./index.html#Examples}Example section}}. - documentation for - {{{/shared/maven-archiver/}Maven Archiver}}. - To handle archiving this version of Maven JAR Plugin uses + To handle archiving, this version of the Maven JAR Plugin uses {{{/shared/maven-archiver/index.html}Maven Archiver}} ${mavenArchiverVersion}. - <> If you need to sign your JAR files you should use the + <> If you need to sign your JAR files, you should use the {{{/plugins/maven-jarsigner-plugin/}Maven Jarsigner Plugin}} instead. * How to build a JAR file @@ -58,8 +56,8 @@ Usage +----------+ - Since 'jar' is the default packaging type it is not required to set it in this case. - Apart from the above you will normally want some real java source files which should be located within + Since 'jar' is the default packaging type, it is not required to set it in this case. + Apart from the above, you will normally want some real Java source files which should be located within <<>>. If you need extra resources on your classpath (for example property files) they should be located in <<>>. Now we can create a JAR-file by using the command below: @@ -70,11 +68,11 @@ mvn package The 'package' phase is always responsible for bundling all the files in the artifact, in this case a JAR-file. - In your project's <<>> directory you'll see the generated jar file which is named like: + In your project's <<>> directory, you'll see the generated jar file which is named like: 'core-1.0-SNAPSHOT.jar'. The resulting 'jar' file contains the compiled java class files as well as the files from <<>>. - Usually there is no need to mentioned the 'maven-jar-plugin' explicit cause it's bound to + Usually there is no need to mention the 'maven-jar-plugin' explicitly because it's bound to the {{{/guides/introduction/introduction-to-the-lifecycle.html}Maven Build Life Cycle}}. For full documentation, click {{{./plugin-info.html}here}}. @@ -85,7 +83,7 @@ mvn package {{{https://cr.openjdk.java.net/~mr/jigsaw/spec/jar.html}changes in the JAR file specifications}} as well - Modular JAR files. Modular JAR files are JAR files with <<>> file in the root directory (or in the versioned area for multi-release JAR files). If the project contains <<>> - the resulting JAR will be a Modular JAR without a need for any configuration regardless of the plugin version used. + the resulting JAR will be a modular JAR without a need for any configuration regardless of the plugin version used. Starting with version 3.1.2, if the JAR file contains <<>>, this plugin will update the modular descriptor (<<>>) with additional attributes such as the list of packages included @@ -95,5 +93,5 @@ mvn package (for example how to set it read {{{../../shared/maven-archiver/examples/classpath.html}Make The Jar Executable}}). Internally the plugin uses the JDK <<>> tool so in order to add the additional attributes and to verify the modular descriptor Maven should be run with JDK version 9 or newer. If version 8 or earlier is used - the resulting JAR still will be Modular JAR (as it contains <<>>) but no additional attributes + the resulting JAR will still be a modular JAR (as it contains <<>>) but no additional attributes will be added and no validation will be performed.