You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by GitBox <gi...@apache.org> on 2020/12/17 20:24:07 UTC
[GitHub] [maven-jlink-plugin] bdemers commented on a change in pull request #25: [MJLINK-49] documentation update
bdemers commented on a change in pull request #25:
URL: https://github.com/apache/maven-jlink-plugin/pull/25#discussion_r545208412
##########
File path: src/site/apt/usage.apt.vm
##########
@@ -76,11 +76,15 @@ Usage
* Usage of the Maven JLink Plugin
- Usually you will use the Maven JLink Plugin to create a Run Time Image from one or more modules within
- a multi module build.
- In other words it is not possible to create a Run Time Image from a single Maven
- Project within the same single Maven Project.
- Let us assume you have a multi module structure which contains two modules <<mod-1>> and <<mod-2>>
+ You can use the maven-jlink-plugin the same way you use the maven-jar-plugin, maven-war-plugin,
+ maven-assembly-plugin or any other artifact-generating plugin.
+ You can choose to have a separate module for the artifact generation by specifying
+ <<< <packaging>jlink</packaging> >>>.
+
+ You can also add it to your existing project by adding an explicit execution, probably
+ in the <<<package>>> phase.
Review comment:
```suggestion
You can also add it to an existing project by adding an explicit plugin execution
in the <<<package>>> phase.
```
##########
File path: src/site/apt/usage.apt.vm
##########
@@ -76,11 +76,15 @@ Usage
* Usage of the Maven JLink Plugin
- Usually you will use the Maven JLink Plugin to create a Run Time Image from one or more modules within
- a multi module build.
- In other words it is not possible to create a Run Time Image from a single Maven
- Project within the same single Maven Project.
- Let us assume you have a multi module structure which contains two modules <<mod-1>> and <<mod-2>>
+ You can use the maven-jlink-plugin the same way you use the maven-jar-plugin, maven-war-plugin,
+ maven-assembly-plugin or any other artifact-generating plugin.
+ You can choose to have a separate module for the artifact generation by specifying
+ <<< <packaging>jlink</packaging> >>>.
+
+ You can also add it to your existing project by adding an explicit execution, probably
+ in the <<<package>>> phase.
Review comment:
remove "probably" to make it sound more confident
##########
File path: src/site/apt/usage.apt.vm
##########
@@ -76,11 +76,15 @@ Usage
* Usage of the Maven JLink Plugin
- Usually you will use the Maven JLink Plugin to create a Run Time Image from one or more modules within
- a multi module build.
- In other words it is not possible to create a Run Time Image from a single Maven
- Project within the same single Maven Project.
- Let us assume you have a multi module structure which contains two modules <<mod-1>> and <<mod-2>>
+ You can use the maven-jlink-plugin the same way you use the maven-jar-plugin, maven-war-plugin,
+ maven-assembly-plugin or any other artifact-generating plugin.
+ You can choose to have a separate module for the artifact generation by specifying
+ <<< <packaging>jlink</packaging> >>>.
+
+ You can also add it to your existing project by adding an explicit execution, probably
+ in the <<<package>>> phase.
Review comment:
nit: multiple lines start with the same "you can", consider using a bulleted list to avoid the repetition
##########
File path: src/site/apt/usage.apt.vm
##########
@@ -76,11 +76,15 @@ Usage
* Usage of the Maven JLink Plugin
- Usually you will use the Maven JLink Plugin to create a Run Time Image from one or more modules within
- a multi module build.
- In other words it is not possible to create a Run Time Image from a single Maven
- Project within the same single Maven Project.
- Let us assume you have a multi module structure which contains two modules <<mod-1>> and <<mod-2>>
+ You can use the maven-jlink-plugin the same way you use the maven-jar-plugin, maven-war-plugin,
+ maven-assembly-plugin or any other artifact-generating plugin.
+ You can choose to have a separate module for the artifact generation by specifying
+ <<< <packaging>jlink</packaging> >>>.
+
+ You can also add it to your existing project by adding an explicit execution, probably
+ in the <<<package>>> phase.
+
+ Let us assume you have a multi module structure which contains two modules <<mod-1>> and <<mod-2>>
Review comment:
```suggestion
Let's assume you have a multi module structure that contains two modules <<mod-1>> and <<mod-2>>
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org