svn commit: r1807810 - in /maven/plugins/trunk/maven-jmod-plugin/src: main/java/org/apache/maven/plugins/jmod/JModDescribeMojo.java site/apt/usage.apt.vm

[kh...@apache.org]

Author: khmarbaise
Date: Fri Sep  8 19:44:32 2017
New Revision: 1807810

URL: http://svn.apache.org/viewvc?rev=1807810&view=rev
Log:
Improved docs
Added TODO

Modified:
    maven/plugins/trunk/maven-jmod-plugin/src/main/java/org/apache/maven/plugins/jmod/JModDescribeMojo.java
    maven/plugins/trunk/maven-jmod-plugin/src/site/apt/usage.apt.vm

Modified: maven/plugins/trunk/maven-jmod-plugin/src/main/java/org/apache/maven/plugins/jmod/JModDescribeMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jmod-plugin/src/main/java/org/apache/maven/plugins/jmod/JModDescribeMojo.java?rev=1807810&r1=1807809&r2=1807810&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jmod-plugin/src/main/java/org/apache/maven/plugins/jmod/JModDescribeMojo.java (original)
+++ maven/plugins/trunk/maven-jmod-plugin/src/main/java/org/apache/maven/plugins/jmod/JModDescribeMojo.java Fri Sep  8 19:44:32 2017
@@ -69,9 +69,8 @@ public class JModDescribeMojo
 
         getLog().info( "Toolchain in maven-jmod-plugin: jmod [ " + jModExecutable + " ]" );
 
-        // We need to put the resulting x.jmod files into jmods folder otherwise is
-        // seemed to be not working.
-        // Check why?
+        //TODO: Need to think about if we really require to have the jmod
+        // file being located in the target directory?
         File modsFolder = new File( outputDirectory, "jmods" );
         File resultingJModFile = new File( modsFolder, moduleName + ".jmod" );
 

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=1807810&r1=1807809&r2=1807810&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 Fri Sep  8 19:44:32 2017
@@ -53,10 +53,20 @@ Usage
 </project>
 +-----
 
-  The configuration elements contains the configuration for the plugin 
-  {{{https://maven.apache.org/guides/mini/guide-configuring-plugins.html}}like any other Maven plugin}}.
+  The configuration elements contains the configuration for the plugin
+  {{{https://maven.apache.org/guides/mini/guide-configuring-plugins.html}like any other Maven plugin}}.
+  The different elements which can be configured for this plugin can identified by the
+  {{{./plugin-info.html}goals documentation}}.
+
+* Requirements
+
+  Based on the foundation of the plugin it is required to have JDK 9 installed. This means
+  either you have it configured via <<JAVA_HOME>> which means to run the whole
+  Maven build with JDK 9 or via <<Toolchains>>.
+
+  Howto configure Maven related to Toolchains can be read in the
+  {{{https://maven.apache.org/guides/mini/guide-using-toolchains.html}Toolchains documentation}}.
 
-  
 * Usage of the Maven JMod Plugin
 
   JMod files can contain supplemental configuration files, native libraries,