svn commit: r1807102 - in /maven/plugins/trunk/maven-jlink-plugin/src: main/java/org/apache/maven/plugins/jlink/JLinkMojo.java site/apt/usage.apt.vm

[kh...@apache.org]

Author: khmarbaise
Date: Sat Sep  2 22:03:17 2017
New Revision: 1807102

URL: http://svn.apache.org/viewvc?rev=1807102&view=rev
Log:
Changed location for resulting run time image
Added more docs.

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

Modified: maven/plugins/trunk/maven-jlink-plugin/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jlink-plugin/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java?rev=1807102&r1=1807101&r2=1807102&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jlink-plugin/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java (original)
+++ maven/plugins/trunk/maven-jlink-plugin/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java Sat Sep  2 22:03:17 2017
@@ -41,6 +41,10 @@ import org.codehaus.plexus.util.FileUtil
 import org.codehaus.plexus.util.cli.Commandline;
 
 /**
+ * The JLink goal is intended to create a Java Run Time Image file.
+ * 
+ * 
+ * 
  * <pre>
  * Usage: jlink &lt;options&gt; --module-path &lt;modulepath&gt; --add-modules &lt;module&gt;[,&lt;module&gt;...]
  * Possible options include:
@@ -82,7 +86,7 @@ import org.codehaus.plexus.util.cli.Comm
  * 
  * @author Karl Heinz Marbaise <a href="mailto:khmarbaise@apache.org">khmarbaise@apache.org</a>
  */
-// TODO: Check things about conf files?
+// TODO: Check if the resolution scope is correct?
 // CHECKSTYLE_OFF: LineLength
 @Mojo( name = "jlink", requiresDependencyResolution = ResolutionScope.COMPILE_PLUS_RUNTIME, defaultPhase = LifecyclePhase.PACKAGE, requiresProject = true )
 // CHECKSTYLE_ON: LineLength
@@ -154,11 +158,13 @@ public class JLinkMojo
     private String pluginModulePath;
 
     /**
-     * The output directory for the resulting Run Time Image. This is stored in non compressed form.
+     * The output directory for the resulting Run Time Image. The created 
+     * Run Time Image is stored in non compressed form. This will later being
+     * packaged into a <code>zip</code> file.
      * <code>--output &lt;path&gt;</code>
      */
     // TODO: is this a good final location?
-    @Parameter( defaultValue = "${project.build.directory}/jlink" )
+    @Parameter( defaultValue = "${project.build.directory}/maven-jlink", required = true, readonly = true )
     private File outputDirectoryImage;
 
     @Parameter( defaultValue = "${project.build.directory}", required = true, readonly = true )

Modified: maven/plugins/trunk/maven-jlink-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-jlink-plugin/src/site/apt/usage.apt.vm?rev=1807102&r1=1807101&r2=1807102&view=diff
==============================================================================
--- maven/plugins/trunk/maven-jlink-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-jlink-plugin/src/site/apt/usage.apt.vm Sat Sep  2 22:03:17 2017
@@ -227,7 +227,9 @@ mvn clean deploy
   At the moment the resulting Java Run Time Image is packaged into a <<zip>> archive which 
   used to transport the whole structure which is created by <<jlink>> to a repository.
 
-  The basic structure of the resulting Java Run Time Image looks like this:
+  The resulting 
+  {{{https://docs.oracle.com/javase/9/install/installed-directory-structure-jdk-and-jre.htm}Java Run Time Image directory structure}}
+  looks like this:
   
 +---
 jlink/
@@ -239,3 +241,5 @@ jlink/
 └── release
 +---
 
+  
+