You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2017/09/03 13:24:05 UTC
svn commit: r1807146 - in /maven/plugins/trunk/maven-jmod-plugin/src/site:
apt/examples/ apt/examples/example-describe.apt.vm
apt/examples/example-list.apt.vm apt/index.apt.vm apt/usage.apt.vm site.xml
Author: khmarbaise
Date: Sun Sep 3 13:24:04 2017
New Revision: 1807146
URL: http://svn.apache.org/viewvc?rev=1807146&view=rev
Log:
Improved docs.
Added:
maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-describe.apt.vm
maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-list.apt.vm
Modified:
maven/plugins/trunk/maven-jmod-plugin/src/site/apt/index.apt.vm
maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm
maven/plugins/trunk/maven-jmod-plugin/src/site/site.xml
Added: maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-describe.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-describe.apt.vm?rev=1807146&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-describe.apt.vm (added)
+++ maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-describe.apt.vm Sun Sep 3 13:24:04 2017
@@ -0,0 +1,79 @@
+ ------
+ Usage
+ ------
+ Karl Heinz Marbaise <kh...@apache.org>
+ ------
+ 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
+
+* Describe Goal
+
+ Assuming you have configured the Maven JMod Plugin
+ {{{./usage.html}accordingly to the usage page}} like the following:
+
++----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <artifactId>maven-jmod-plugin</artifactId>
+ <version>${project.version}</version>
+ <extensions>true</extensions>
+ <configuration>
+ <!-- configuration elements goes here -->
+ </configuration>
+ <executions>
+ <execution>
+ <id>describe</id>
+ <goals>
+ <goal>describe</goal>
+ </goals>
+ <phase>verify</phase>
+ </execution>
+ </executions>
+ </plugin>
+ </plugin>
+ [...]
+</project>
++-----
+
+ You can run via:
+
++-----
+mvn clean verify
++-----
+
+ During the above call of Maven the <<jmod>> files will be generated and by the <<describe>> goal
+ you will get an output like the following (using toolchains):
+
++----
+[INFO] --- maven-jmod-plugin:${project.version}:describe (describe) @ first-jmod ---
+[INFO] Toolchain in maven-jmod-plugin: jmod [ /../jdk1.9.0_ea+181.jdk/Contents/Home/bin/jmod ]
+[INFO] The following information is contained in the module file /.../maven-single-jmod-example/target/jmods/first-jmod.jmod
+[INFO] com.corporate.project@1.0-SNAPSHOT
+[INFO] exports com.corporate.project
+[INFO] requires java.base
++----
+
Added: maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-list.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-list.apt.vm?rev=1807146&view=auto
==============================================================================
--- maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-list.apt.vm (added)
+++ maven/plugins/trunk/maven-jmod-plugin/src/site/apt/examples/example-list.apt.vm Sun Sep 3 13:24:04 2017
@@ -0,0 +1,88 @@
+ ------
+ Usage
+ ------
+ Karl Heinz Marbaise <kh...@apache.org>
+ ------
+ 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
+
+* List Goal
+
+ Assuming you have configured the Maven JMod Plugin
+ {{{/usage.html}accordingly to the usage page}} like the following:
+
++----
+<project>
+ [...]
+ <build>
+ [...]
+ <plugins>
+ [...]
+ <plugin>
+ <artifactId>maven-jmod-plugin</artifactId>
+ <version>${project.version}</version>
+ <extensions>true</extensions>
+ <configuration>
+ <!-- configuration elements goes here -->
+ </configuration>
+ <executions>
+ <execution>
+ <id>list</id>
+ <goals>
+ <goal>list</goal>
+ </goals>
+ <phase>verify</phase>
+ </execution>
+ </executions>
+ </plugin>
+ </plugin>
+ [...]
+</project>
++-----
+
+ You can run via:
+
++-----
+mvn clean verify
++-----
+
+ During the above call of Maven the <<jmod>> files will be generated and by the <<list>> goal
+ you will get an output like the following (using toolchains):
+
++----
+[INFO] --- maven-jmod-plugin:${project.version}:list (list) @ first-jmod ---
+[INFO] Toolchain in maven-jmod-plugin: jmod [ /../jdk1.9.0_ea+181.jdk/Contents/Home/bin/jmod ]
+[INFO] The following files are contained in the module file /../maven-single-jmod-example/target/jmods/first-jmod.jmod
+[INFO] classes/module-info.class
+[INFO] classes/com/corporate/project/Main.class
+[INFO] conf/config.1
+[INFO] conf/config.2
+[INFO] conf/sub-configuration/config.sub
+[INFO] include/first.h
+[INFO] legal/first.md
+[INFO] bin/first.cmd
+[INFO] bin/first.sh
+[INFO] bin/test.sh
+[INFO] lib/native-lib.so
+[INFO]
++----
+
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=1807146&r1=1807145&r2=1807146&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:24:04 2017
@@ -67,6 +67,8 @@ ${project.name}
To provide you with better understanding on some usages of the Maven JMod Plugin,
you can take a look into the following examples:
- TODO: Add examples.
+ * {{{/examples/example-list.html}Usage of jmod:list}} goal.
+
+ * {{{/examples/example-describe.html}Usage of jmod:describe}} goal.
[]
Modified: 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=1807146&r1=1807145&r2=1807146&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm Sun Sep 3 13:24:04 2017
@@ -132,11 +132,11 @@ mvn clean package
+----
[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] Toolchain in maven-surefire-plugin: JDK[/../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] Toolchain in maven-jmod-plugin: jmod [ /../jdk1.9.0_ea+181.jdk/Contents/Home/bin/jmod ]
[INFO]
+----
Modified: maven/plugins/trunk/maven-jmod-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jmod-plugin/src/site/site.xml?rev=1807146&r1=1807145&r2=1807146&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jmod-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-jmod-plugin/src/site/site.xml Sun Sep 3 13:24:04 2017
@@ -37,8 +37,9 @@ under the License.
<item name="License" href="http://www.apache.org/licenses/"/>
<item name="Download" href="download.html"/>
</menu>
-<!-- <menu name="Examples"> -->
-<!-- <item name="Installing Artifact with Custom POM" href="examples/custom-pom-installation.html"/> -->
-<!-- </menu> -->
+ <menu name="Examples">
+ <item name="Describe Goal" href="examples/example-describe.html"/>
+ <item name="List Goal" href="examples/example-list.html"/>
+ </menu>
</body>
</project>