Author: khmarbaise
Date: Sun Sep 3 13:06:34 2017
New Revision: 1807145
URL: http://svn.apache.org/viewvc?rev=1807145&view=rev
Log:
Improved docs.
Added:
maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm
Modified:
maven/plugins/trunk/maven-jmod-plugin/src/site/apt/index.apt.vm
Modified: maven/plugins/trunk/maven-jmod-plugin/src/site/apt/index.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jmod-plugin/src/site/apt/index.apt.vm?rev=1807145&r1=1807144&r2=1807145&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jmod-plugin/src/site/apt/index.apt.vm (original)
+++ maven/plugins/trunk/maven-jmod-plugin/src/site/apt/index.apt.vm Sun Sep 3
13:06:34 2017
@@ -42,9 +42,6 @@ ${project.name}
* {{{./help-mojo.html}jmod:help}} displays help information on
maven-jmod-plugin.
- At the moment support for extract, list, describe does not exist. If you
need such support
- please open a {{{./issue-tracking.html}JIRA ticket}} in our issue tracker.
-
[]
* Usage
Added: maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm?rev=1807145&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm (added)
+++ maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm Sun Sep 3
13:06:34 2017
@@ -0,0 +1,155 @@
+ ------
+ Usage
+ ------
+ Karl Heinz Marbaise <[email protected]>
+ ------
+ 2017-09-01
+
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/doxia/references/apt-format.html
+
+
+Usage
+
+* Introduction
+
+ The Maven JMod plugin is used to create
{{{http://openjdk.java.net/jeps/261}JMod Files}} in JDK 9.
+
+* Configuration of the Maven JMod Plugin
+
+ To use the Maven JMod Plugin you have to configure it as an <<<extensions>>>
which means
+ the configuration in your pom file has to look like this:
+
++-----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <artifactId>maven-jmod-plugin</artifactId>
+ <version>${project.version}</version>
+ <extensions>true</extensions>
+ <configuration>
+ <!-- configuration elements goes here -->
+ </configuration>
+ </plugin>
+ [...]
+</project>
++-----
+
+ The configuration elements contains the configuration for the plugin like
+ any other Maven plugins.
+
+
+* Usage of the Maven JMod Plugin
+
+ JMod files are intended to create <<jmod>> files which can contain
supplemental
+ configuration files, native libraries, legals notices, header files, man
pages,
+ native commands. The JMod files are intended to be used in relationship with
+ {{{https://maven.apache.org/plugins/maven-jlink-plugin/}JLink}} to produce
Java
+ Run Time Images.
+
+ An important thing to mention is that <<jmod>> files are not intended to be
used
+ for run time and usual module relationships (You can't run a jvm via java
using
+ jmod files). For such purposes <<jar>> files exists.
+
+ You can simply create a <<jmod>> file by defining the packaging <<jmod>> in
your
+ pom file.
+
+ The <<first-mod>> project looks similar like this (apart from the above
configuration):
+
++-----
+<project ...>
+ <modelVersion>4.0.0</modelVersion>
+ [...]
+ <groupId>com.corporate.project</groupId>
+ <artifactId>first-mod</artifactId>
+ <verison>1.0-SNAPSHOT</version>
+ <packaging>jmod</packaging>
+ [...]
+</project>
++-----
+
+ You can now put supplemental configuration files, header files, native
libraries into
+ the appropriate directories.
+ An example source tree looks like this:
+
++----
+src/
+âââ main
+ âââ cmds
+ â  âââ first.cmd
+ â  âââ first.sh
+ â  âââ test.sh
+ âââ configs
+ â  âââ config.1
+ â  âââ config.2
+ â  âââ sub-configuration
+ â  âââ config.sub
+ âââ headerfiles
+ â  âââ first.h
+ âââ java
+ â  âââ com
+ â  â  âââ corporate
+ â  â  âââ project
+ â  â  âââ Main.java
+ â  âââ module-info.java
+ âââ legalnotices
+ â  âââ first.md
+ âââ libs
+ âââ native-lib.so
++----
+
+ The above directories like <<cmds>>, <<configs>>, <<headerfiles>>,
<<legalnotices>> and <<libs>> are
+ the default directories which are defined by the Maven JMod Plugin. If you
really need different
+ directories to be used {{{./create-mojo.html}you can of course configure
this}} but we don't recommend
+ this. You should follow convention over configuration paradigm.
+
+ Finally if you like to create the <<jmod>> file this can be achieved by
using the usual Maven call
+ like this:
+
++----
+mvn clean package
++----
+
+ There will be some output lines like this (This is configured using
toolchains):
+
++----
+[INFO] --- maven-surefire-plugin:2.19.1:test (default-test) @ first-jmod ---
+[INFO] Toolchain in maven-surefire-plugin:
JDK[/Library/Java/JavaVirtualMachines/jdk1.9.0_ea+181.jdk/Contents/Home]
+[INFO] No tests to run.
+[INFO]
+[INFO] --- maven-jmod-plugin:${project.version}:create (default-create) @
first-jmod ---
+[INFO] Toolchain in maven-jmod-plugin: jmod [
/Library/Java/JavaVirtualMachines/jdk1.9.0_ea+181.jdk/Contents/Home/bin/jmod ]
+[INFO]
++----
+
+ If you like to install the resulting <<jmod>> file you can of course use:
+
++----
+mvn clean install
++----
+
+ or if you like to deploy the resulting artifacts to a remote repository you
have to use:
+
++----
+mvn clean deploy
++----
+
+ The <<jmod>> files will be really installed/deployed as <<jmod>> file with
the according extension.
