You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by kh...@apache.org on 2017/09/03 13:28:34 UTC

svn commit: r1017651 [5/6] - in /websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST: ./ apidocs/ apidocs/org/apache/maven/plugins/jmod/ apidocs/org/apache/maven/plugins/jmod/class-use/ apidocs/resources/ examples/ xref/org/a...

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/findbugs.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/findbugs.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/findbugs.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/hash-mojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/hash-mojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/hash-mojo.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/help-mojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/help-mojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/help-mojo.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/index.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/index.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/index.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>
@@ -412,8 +427,9 @@
 <p>The JMod Plugin has currently two goals:</p>
 <ul>
 <li><a href="./create-mojo.html">jmod:create</a> Create jmod files.</li>
-<li><a href="./help-mojo.html">jmod:help</a> displays help information on maven-jmod-plugin.
-<p>At the moment support for extract, list, describe does not exist. If you need such support please open a <a href="./issue-tracking.html">JIRA ticket</a> in our issue tracker. </p></li></ul></div>
+<li><a href="./list-mojo.html">jmod:list</a> List content of a jmod file.</li>
+<li><a href="./describe-mojo.html">jmod:describe</a> List content of a jmod file (module version etc.)</li>
+<li><a href="./help-mojo.html">jmod:help</a> displays help information on maven-jmod-plugin.</li></ul></div>
 <div class="section">
 <h3><a name="Usage"></a>Usage</h3>
 <p>General instructions on how to use the JMod Plugin can be found on the <a href="./usage.html">usage page</a>. Some more specific use cases are described in the examples given below.</p>
@@ -422,7 +438,9 @@
 <div class="section">
 <h3><a name="Examples"></a>Examples</h3>
 <p>To provide you with better understanding on some usages of the Maven JMod Plugin, you can take a look into the following examples:</p>
-<p>TODO: Add examples.</p></div></div>
+<ul>
+<li><a href="/examples/example-list.html">Usage of jmod:list</a> goal.</li>
+<li><a href="/examples/example-describe.html">Usage of jmod:describe</a> goal.</li></ul></div></div>
                   </div>
             </div>
           </div>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/integration.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/integration.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/integration.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/issue-tracking.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/issue-tracking.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/issue-tracking.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/list-mojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/list-mojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/list-mojo.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>
@@ -317,7 +332,8 @@
       
 <p><b>Description</b>:</p>
       
-<div>This goal is to support the usage of <tt>jmod list</tt>.</div>
+<div>This goal is to support the usage of <tt>jmod list</tt> to show
+the content of a <tt>jmod</tt> file.</div>
       
 <p><b>Attributes</b>:</p>
       

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/mail-lists.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/mail-lists.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/mail-lists.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugin-info.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugin-info.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugin-info.html Sun Sep  3 13:28:33 2017
@@ -129,6 +129,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>
@@ -384,10 +399,11 @@
 <tr class="b">
 <td><a href="create-mojo.html">jmod:create</a></td>
 <td>The <code>create</code> goal is intended to create
-<code>jmod</code> files which can be used for later linking via
-<code>maven-jlink-plugin</code>. The JMod files can not be used as
-usual dependencies on the classpath only in relationship with
-maven-jlink-plugin.</td></tr>
+<code>jmod</code> files which can be used for later linking via <a
+href="https://maven.apache.org/plugins/maven-jlink-plugin/">maven-jlink-plugin</a>.
+The <code>jmod</code> files can not be used as usual dependencies
+on the classpath only in relationship with
+<code>maven-jlink-plugin</code>.</td></tr>
 <tr class="a">
 <td><a href="describe-mojo.html">jmod:describe</a></td>
 <td>This goal is to support the usage of <code>jmod describe</code>.</td></tr>
@@ -403,7 +419,8 @@ Call <code>mvn jmod:help -Ddetail=true
 -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</td></tr>
 <tr class="b">
 <td><a href="list-mojo.html">jmod:list</a></td>
-<td>This goal is to support the usage of <code>jmod list</code>.</td></tr></table>
+<td>This goal is to support the usage of <code>jmod list</code> to show
+the content of a <code>jmod</code> file.</td></tr></table>
 <div class="section">
 <h3><a name="System_Requirements"></a>System Requirements</h3><a name="System_Requirements"></a>
 <p>The following specifies the minimum requirements to run this Maven plugin:</p>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugin-management.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugin-management.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugin-management.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugins.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugins.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/plugins.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/pmd.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/pmd.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/pmd.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>
@@ -389,10 +404,10 @@
 <th>Line</th></tr>
 <tr class="b">
 <td>Useless parentheses.</td>
-<td><a href="./xref/org/apache/maven/plugins/jmod/AbstractJModMojo.html#L115">115</a></td></tr>
+<td><a href="./xref/org/apache/maven/plugins/jmod/AbstractJModMojo.html#L116">116</a></td></tr>
 <tr class="a">
 <td>Useless parentheses.</td>
-<td><a href="./xref/org/apache/maven/plugins/jmod/AbstractJModMojo.html#L116">116</a></td></tr></table></div>
+<td><a href="./xref/org/apache/maven/plugins/jmod/AbstractJModMojo.html#L117">117</a></td></tr></table></div>
 <div class="section">
 <h3><a name="orgapachemavenpluginsjmodJModCreateMojo.java"></a>org/apache/maven/plugins/jmod/JModCreateMojo.java</h3>
 <table border="0" class="table table-striped">

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-info.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-info.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-info.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                               
       <li class="active">

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-reports.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-reports.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-reports.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-summary.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-summary.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/project-summary.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/sonar.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/sonar.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/sonar.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/source-repository.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/source-repository.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/source-repository.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/surefire-report.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/surefire-report.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/surefire-report.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/taglist.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/taglist.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/taglist.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                           
       <li>
@@ -406,7 +421,7 @@
 <th>Line</th></tr>
 <tr class="b">
 <td>Check how to prevent code duplication in maven-jlink, maven-jmod and maven-jdeps plugin?</td>
-<td><a href="./xref/org/apache/maven/plugins/jmod/AbstractJModMojo.html#60">60</a></td></tr>
+<td><a href="./xref/org/apache/maven/plugins/jmod/AbstractJModMojo.html#61">61</a></td></tr>
 <tr class="a">
 <th>org.apache.maven.plugins.jmod.JModCreateMojo</th>
 <th>Line</th></tr>

Modified: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/team-list.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/team-list.html (original)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/team-list.html Sun Sep  3 13:28:33 2017
@@ -131,6 +131,21 @@
           <span class="none"></span>
         Download</a>
             </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
                               <li class="nav-header">Project Documentation</li>
                                                                                                                                                                                                                                                                                                                                     
       <li>

Added: websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/usage.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/usage.html (added)
+++ websites/production/maven/components/plugins-archives/maven-jmod-plugin-LATEST/usage.html Sun Sep  3 13:28:33 2017
@@ -0,0 +1,423 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.7.1 at 2017-09-03 
+ | Rendered using Apache Maven Fluido Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="author" content="Karl Heinz Marbaise khmarbaise@apache.org" />
+    <meta name="Date-Creation-yyyymmdd" content="20170901" />
+    <meta name="Date-Revision-yyyymmdd" content="20170903" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Apache Maven JMod Plugin &#x2013; Usage</title>
+    <link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
+    <link rel="stylesheet" href="./css/site.css" />
+    <link rel="stylesheet" href="./css/print.css" media="print" />
+
+      
+    
+          <style type="text/css">body{background-image: url('./images/profiles/pre-release.png');}</style>
+    
+  
+    <script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>
+
+                  <!-- Google Analytics -->
+    <script type="text/javascript">
+
+      var _gaq = _gaq || [];
+      _gaq.push(['_setAccount', 'UA-140879-1']);
+      _gaq.push(['_trackPageview']);
+
+      (function() {
+        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+      })();
+
+    </script>
+          </head>
+        <body class="topBarDisabled">
+          
+                
+                    
+    
+        <div class="container-fluid">
+          <div id="banner">
+        <div class="pull-left">
+                                    <a href="https://www.apache.org/" id="bannerLeft">
+                                                                                                <img src="../../images/apache-maven-project.png"  alt="Apache Maven JMod Plugin"/>
+                </a>
+                      </div>
+        <div class="pull-right">                                <a href="../../" id="bannerRight">
+                                                                                                <img src="../../images/maven-logo-black-on-white.png" />
+                </a>
+      </div>
+        <div class="clear"><hr/></div>
+      </div>
+
+      <div id="breadcrumbs">
+        <ul class="breadcrumb">
+              
+                              <li class="">
+                    <a href="https://www.apache.org/" class="externalLink" title="Apache">
+        Apache</a>
+                    <span class="divider">/</span>
+      </li>
+            <li class="">
+                    <a href="../../index.html" title="Maven">
+        Maven</a>
+                    <span class="divider">/</span>
+      </li>
+            <li class="">
+                    <a href="../index.html" title="Plugins">
+        Plugins</a>
+                    <span class="divider">/</span>
+      </li>
+            <li class="">
+                    <a href="index.html" title="Apache Maven JMod Plugin">
+        Apache Maven JMod Plugin</a>
+                    <span class="divider">/</span>
+      </li>
+        <li class="active ">Usage</li>
+        
+              
+                  <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2017-09-03</li>
+              <li id="projectVersion" class="pull-right">
+                    Version: 3.0.0-SNAPSHOT
+        </li>
+            
+                            </ul>
+      </div>
+
+            
+      <div class="row-fluid">
+        <div id="leftColumn" class="span2">
+          <div class="well sidebar-nav">
+              
+                <ul class="nav nav-list">
+                    <li class="nav-header">Overview</li>
+                              
+      <li>
+  
+                          <a href="index.html" title="Introduction">
+          <span class="none"></span>
+        Introduction</a>
+            </li>
+                
+      <li>
+  
+                          <a href="plugin-info.html" title="Goals">
+          <span class="none"></span>
+        Goals</a>
+            </li>
+                
+      <li class="active">
+  
+            <a href="#"><span class="none"></span>Usage</a>
+          </li>
+                
+      <li>
+  
+                          <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+          <span class="none"></span>
+        License</a>
+            </li>
+                
+      <li>
+  
+                          <a href="download.html" title="Download">
+          <span class="none"></span>
+        Download</a>
+            </li>
+                              <li class="nav-header">Examples</li>
+                              
+      <li>
+  
+                          <a href="examples/example-describe.html" title="Describe Goal">
+          <span class="none"></span>
+        Describe Goal</a>
+            </li>
+                
+      <li>
+  
+                          <a href="examples/example-list.html" title="List Goal">
+          <span class="none"></span>
+        List Goal</a>
+            </li>
+                              <li class="nav-header">Project Documentation</li>
+                                                                                                                                                                                                                                                                                                                          
+      <li>
+  
+                          <a href="project-info.html" title="Project Information">
+          <span class="icon-chevron-right"></span>
+        Project Information</a>
+                  </li>
+                                                                                                                                                                                                                                    
+      <li>
+  
+                          <a href="project-reports.html" title="Project Reports">
+          <span class="icon-chevron-right"></span>
+        Project Reports</a>
+                  </li>
+                              <li class="nav-header">Maven Projects</li>
+                              
+      <li>
+  
+                          <a href="../../archetype/index.html" title="Archetype">
+          <span class="none"></span>
+        Archetype</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../doxia/index.html" title="Doxia">
+          <span class="none"></span>
+        Doxia</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../jxr/index.html" title="JXR">
+          <span class="none"></span>
+        JXR</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../ref/current" title="Maven">
+          <span class="none"></span>
+        Maven</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../pom/index.html" title="Parent POMs">
+          <span class="none"></span>
+        Parent POMs</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../index.html" title="Plugins">
+          <span class="none"></span>
+        Plugins</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../plugin-testing/index.html" title="Plugin Testing">
+          <span class="none"></span>
+        Plugin Testing</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../plugin-tools/index.html" title="Plugin Tools">
+          <span class="none"></span>
+        Plugin Tools</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../apache-resource-bundles/index.html" title="Resource Bundles">
+          <span class="none"></span>
+        Resource Bundles</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../scm/index.html" title="SCM">
+          <span class="none"></span>
+        SCM</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../shared/index.html" title="Shared Components">
+          <span class="none"></span>
+        Shared Components</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../skins/index.html" title="Skins">
+          <span class="none"></span>
+        Skins</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../surefire/index.html" title="Surefire">
+          <span class="none"></span>
+        Surefire</a>
+            </li>
+                
+      <li>
+  
+                          <a href="../../wagon/index.html" title="Wagon">
+          <span class="none"></span>
+        Wagon</a>
+            </li>
+                              <li class="nav-header">ASF</li>
+                              
+      <li>
+  
+                          <a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
+          <span class="none"></span>
+        How Apache Works</a>
+            </li>
+                
+      <li>
+  
+                          <a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation">
+          <span class="none"></span>
+        Foundation</a>
+            </li>
+                
+      <li>
+  
+                          <a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+          <span class="none"></span>
+        Sponsoring Apache</a>
+            </li>
+                
+      <li>
+  
+                          <a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+          <span class="none"></span>
+        Thanks</a>
+            </li>
+            </ul>
+              
+                            <form id="search-form" action="https://www.google.com/search" method="get" >
+    
+  <input value="$sitesearchValue" name="sitesearch" type="hidden"/>
+  <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="https://cse.google.com/brand?form=search-form"></script>
+          
+          <hr />
+
+           <div id="poweredBy">
+                   
+    <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+    
+    <div class="g-plusone" data-href="https://maven.apache.org/plugins/maven-jmod-plugin/" data-size="tall" ></div>
+
+                   <div class="clear"></div>
+                            <div class="clear"></div>
+                            <div class="clear"></div>
+                            <div class="clear"></div>
+                             <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+        <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+      </a>
+                  </div>
+          </div>
+        </div>
+        
+                
+        <div id="bodyColumn"  class="span10" >
+                                  
+            <div class="section">
+<h2><a name="Usage"></a>Usage</h2>
+<div class="section">
+<h3><a name="Introduction"></a>Introduction</h3>
+<p>The Maven JMod plugin is used to create <a class="externalLink" href="http://openjdk.java.net/jeps/261">JMod Files</a> in JDK 9.</p></div>
+<div class="section">
+<h3><a name="Configuration_of_the_Maven_JMod_Plugin"></a>Configuration of the Maven JMod Plugin</h3>
+<p>To use the Maven JMod Plugin you have to configure it as an <tt>extensions</tt> which means the configuration in your pom file has to look like this:</p>
+<div class="source"><pre class="prettyprint linenums">&lt;project&gt;
+  [...]
+  &lt;build&gt;
+    [...]
+    &lt;plugins&gt;
+      [...]
+      &lt;plugin&gt;
+        &lt;artifactId&gt;maven-jmod-plugin&lt;/artifactId&gt;
+        &lt;version&gt;3.0.0-SNAPSHOT&lt;/version&gt;
+        &lt;extensions&gt;true&lt;/extensions&gt;
+        &lt;configuration&gt;
+          &lt;!-- configuration elements goes here --&gt;
+        &lt;/configuration&gt;
+      &lt;/plugin&gt;
+   [...]
+&lt;/project&gt;</pre></div>
+<p>The configuration elements contains the configuration for the plugin like any other Maven plugins.</p></div>
+<div class="section">
+<h3><a name="Usage_of_the_Maven_JMod_Plugin"></a>Usage of the Maven JMod Plugin</h3>
+<p>JMod files are intended to create <b>jmod</b> 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 <a class="externalLink" href="https://maven.apache.org/plugins/maven-jlink-plugin/">JLink</a> to produce Java Run Time Images.</p>
+<p>An important thing to mention is that <b>jmod</b> 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 <b>jar</b> files exists.</p>
+<p>You can simply create a <b>jmod</b> file by defining the packaging <b>jmod</b> in your pom file.</p>
+<p>The <b>first-mod</b> project looks similar like this (apart from the above configuration):</p>
+<div class="source"><pre class="prettyprint linenums">&lt;project ...&gt;
+  &lt;modelVersion&gt;4.0.0&lt;/modelVersion&gt;
+   [...]
+  &lt;groupId&gt;com.corporate.project&lt;/groupId&gt;
+  &lt;artifactId&gt;first-mod&lt;/artifactId&gt;
+  &lt;verison&gt;1.0-SNAPSHOT&lt;/version&gt;
+  &lt;packaging&gt;jmod&lt;/packaging&gt;
+   [...]
+&lt;/project&gt;</pre></div>
+<p>You can now put supplemental configuration files, header files, native libraries into the appropriate directories. An example source tree looks like this:</p>
+<div class="source"><pre class="prettyprint linenums">src/
+&#x2514;&#x2500;&#x2500; main
+    &#x251c;&#x2500;&#x2500; cmds
+    &#x2502;&#xa0;&#xa0; &#x251c;&#x2500;&#x2500; first.cmd
+    &#x2502;&#xa0;&#xa0; &#x251c;&#x2500;&#x2500; first.sh
+    &#x2502;&#xa0;&#xa0; &#x2514;&#x2500;&#x2500; test.sh
+    &#x251c;&#x2500;&#x2500; configs
+    &#x2502;&#xa0;&#xa0; &#x251c;&#x2500;&#x2500; config.1
+    &#x2502;&#xa0;&#xa0; &#x251c;&#x2500;&#x2500; config.2
+    &#x2502;&#xa0;&#xa0; &#x2514;&#x2500;&#x2500; sub-configuration
+    &#x2502;&#xa0;&#xa0;     &#x2514;&#x2500;&#x2500; config.sub
+    &#x251c;&#x2500;&#x2500; headerfiles
+    &#x2502;&#xa0;&#xa0; &#x2514;&#x2500;&#x2500; first.h
+    &#x251c;&#x2500;&#x2500; java
+    &#x2502;&#xa0;&#xa0; &#x251c;&#x2500;&#x2500; com
+    &#x2502;&#xa0;&#xa0; &#x2502;&#xa0;&#xa0; &#x2514;&#x2500;&#x2500; corporate
+    &#x2502;&#xa0;&#xa0; &#x2502;&#xa0;&#xa0;     &#x2514;&#x2500;&#x2500; project
+    &#x2502;&#xa0;&#xa0; &#x2502;&#xa0;&#xa0;         &#x2514;&#x2500;&#x2500; Main.java
+    &#x2502;&#xa0;&#xa0; &#x2514;&#x2500;&#x2500; module-info.java
+    &#x251c;&#x2500;&#x2500; legalnotices
+    &#x2502;&#xa0;&#xa0; &#x2514;&#x2500;&#x2500; first.md
+    &#x2514;&#x2500;&#x2500; libs
+        &#x2514;&#x2500;&#x2500; native-lib.so</pre></div>
+<p>The above directories like <b>cmds</b>, <b>configs</b>, <b>headerfiles</b>, <b>legalnotices</b> and <b>libs</b> are the default directories which are defined by the Maven JMod Plugin. If you really need different directories to be used <a href="./create-mojo.html">you can of course configure this</a> but we don't recommend this. You should follow convention over configuration paradigm.</p>
+<p>Finally if you like to create the <b>jmod</b> file this can be achieved by using the usual Maven call like this:</p>
+<div class="source"><pre class="prettyprint linenums">mvn clean package</pre></div>
+<p>There will be some output lines like this (This is configured using toolchains):</p>
+<div class="source"><pre class="prettyprint linenums">[INFO] --- maven-surefire-plugin:2.19.1:test (default-test) @ first-jmod ---
+[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:3.0.0-SNAPSHOT:create (default-create) @ first-jmod ---
+[INFO] Toolchain in maven-jmod-plugin: jmod [ /../jdk1.9.0_ea+181.jdk/Contents/Home/bin/jmod ]
+[INFO]</pre></div>
+<p>If you like to install the resulting <b>jmod</b> file you can of course use:</p>
+<div class="source"><pre class="prettyprint linenums">mvn clean install</pre></div>
+<p>or if you like to deploy the resulting artifacts to a remote repository you have to use:</p>
+<div class="source"><pre class="prettyprint linenums">mvn clean deploy</pre></div>
+<p>The <b>jmod</b> files will be really installed/deployed as <b>jmod</b> file with the according extension.</p></div></div>
+                  </div>
+            </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+                      <div class="row-fluid">
+                                      <p >Copyright &copy;                    2016&#x2013;2017
+                        <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+            All rights reserved.    
+      </p>
+                </div>
+
+        
+                </div>
+    </footer>
+        </body>
+</html>
\ No newline at end of file