[maven-jlink-plugin] 17/38: Changed location for resulting run time image Added more docs.

[hb...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jlink-plugin.git

commit 51b26782a41ada844279cd524925ea5f6d4b3324
Author: Karl Heinz Marbaise <kh...@apache.org>
AuthorDate: Sat Sep 2 22:03:17 2017 +0000

    Changed location for resulting run time image
    Added more docs.
    
    
    git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@1807102 13f79535-47bb-0310-9956-ffa450edef68
---
 src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java | 12 +++++++++---
 src/site/apt/usage.apt.vm                                   |  6 +++++-
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java b/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java
index a8b7bf3..bf4b474 100644
--- a/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java
+++ b/src/main/java/org/apache/maven/plugins/jlink/JLinkMojo.java
@@ -41,6 +41,10 @@ import org.codehaus.plexus.util.FileUtils;
 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.Commandline;
  * 
  * @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 )
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index a158306..93f631a 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -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
 +---
 
+  
+

-- 
To stop receiving notification emails like this one, please contact
"commits@maven.apache.org" <co...@maven.apache.org>.