src/site/apt/examples/example-describe.apt.vm

  ------
  Usage
  ------
  Karl Heinz Marbaise <khmarbaise@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
+----