From 29b1fed33b0c154cf841d85d5913a491624bd909 Mon Sep 17 00:00:00 2001 From: opencode Date: Wed, 29 Jul 2026 11:56:00 +0000 Subject: [PATCH 1/6] Fix documentation issues in site docs - Fix broken link in site.xml (remove leading / from href) - Fix awkward phrasing: 'relative information' -> 'information' - Fix inconsistent capitalization: 'Plugin' -> 'plugin' - Fix grammar: 'as an XML' -> 'as XML' - Fix awkward phrasing: 'minimalist configurations' -> 'basic configuration' - Fix grammar: 'refers to ask expressions' -> 'is used to evaluate expressions' - Fix: 'current pom' -> 'current project's POM' - Fix: 'You could' -> 'You can' for clarity - Fix: 'i.e.' -> 'e.g.' where examples are given - Fix unclear/awkward sentence about mvn command - Fix typo: 'paremeter' -> 'parameter' - Fix insecure link: http -> https for maven.apache.org - Fix broken JIRA link -> GitHub Issues --- src/site/apt/examples/describe-configuration.apt | 5 ++--- src/site/apt/index.apt.vm | 8 ++++---- src/site/apt/usage.apt | 12 ++++++------ src/site/fml/faq.fml | 4 ++-- src/site/site.xml | 2 +- 5 files changed, 15 insertions(+), 16 deletions(-) diff --git a/src/site/apt/examples/describe-configuration.apt b/src/site/apt/examples/describe-configuration.apt index 9887e2f4..64a6c00a 100644 --- a/src/site/apt/examples/describe-configuration.apt +++ b/src/site/apt/examples/describe-configuration.apt @@ -78,8 +78,7 @@ Configuring Describe Goal * The <<>> Parameter - You could also ask for a single Maven command, i.e. a goal or a phase or a lifecycle. It is the command when you call - Maven, i.e.: + You can also ask for a single Maven command, e.g. a goal, a phase, or a lifecycle: +-----+ # mvn -help @@ -173,7 +172,7 @@ For more information, run 'mvn help:describe [...] -Ddetail' ... +-----+ - If you don't provide a paremeter a list is added with the mojos of the plugin and their + If you don't provide a parameter a list is added with the mojos of the plugin and their descriptions: +-----+ diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index a69f9d03..bdb17e82 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -29,7 +29,7 @@ ${project.name} - The Maven Help Plugin is used to get relative information about a project or the system. It can be used to get a + The Maven Help Plugin is used to get information about a project or the system. It can be used to get a description of a particular plugin, including the plugin's goals with their parameters and component requirements, the effective POM and effective settings of the current build, and the profiles applied to the current project being built. @@ -42,13 +42,13 @@ ${project.name} * {{{./all-profiles-mojo.html}help:all-profiles}} lists the available profiles under the current project. - * {{{./describe-mojo.html}help:describe}} describes the attributes of a Plugin and/or a Mojo (Maven plain Old Java + * {{{./describe-mojo.html}help:describe}} describes the attributes of a plugin and/or a Mojo (Maven plain Old Java Object). - * {{{./effective-pom-mojo.html}help:effective-pom}} displays the effective POM as an XML for the current build, with + * {{{./effective-pom-mojo.html}help:effective-pom}} displays the effective POM as XML for the current build, with the active profiles factored in. If <<>>, a comment is added to each XML element describing the origin of the line. - * {{{./effective-settings-mojo.html}help:effective-settings}} displays the calculated settings as an XML for the + * {{{./effective-settings-mojo.html}help:effective-settings}} displays the calculated settings as XML for the project, given any profile enhancement and the inheritance of the global settings into the user-level settings. * {{{./evaluate-mojo.html}help:evaluate}} evaluates Maven expressions given by the user in an interactive mode. diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt index e61239a9..03ff7ad3 100644 --- a/src/site/apt/usage.apt +++ b/src/site/apt/usage.apt @@ -30,7 +30,7 @@ Usage - Below are the different goals and the minimalist configurations of the Help Plugin. + Below are the different goals and the basic configuration of the Help Plugin. * The <<>> Goal @@ -129,20 +129,20 @@ Usage # mvn help:evaluate -Dartifact=org.apache.maven.plugins:maven-help-plugin ... [INFO] [help:evaluate] -[INFO] Enter the Maven expression i.e. ${project.groupId} or 0 to exit?: +[INFO] Enter the Maven expression e.g. ${project.groupId} or 0 to exit?: ${project.artifactId} [INFO] maven-help-plugin -[INFO] Enter the Maven expression i.e. ${project.groupId} or 0 to exit?: +[INFO] Enter the Maven expression e.g. ${project.groupId} or 0 to exit?: ${project.none} [INFO] null object or invalid expression ... +-----+ - The <<>> parameter refers to ask expressions on the artifact POM. If omitted, the evaluate goal uses the current - pom. + The <<>> parameter is used to evaluate expressions on the specified artifact's POM. If omitted, the evaluate goal uses the current + project's POM. - You could ask for all Maven expressions listed in the Javadoc of the + You can ask for all Maven expressions listed in the Javadoc of the {{{/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html} <<>>}} class. diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml index ae8ef277..ddbb3b73 100644 --- a/src/site/fml/faq.fml +++ b/src/site/fml/faq.fml @@ -29,7 +29,7 @@ under the License. What is a Mojo

- See the Maven FAQ: What is a Mojo. + See the Maven FAQ: What is a Mojo.

@@ -37,7 +37,7 @@ under the License. Why mvn help:active-profiles won't show the active profiles under Maven 2.1?

- See MPH-38 for more info. + See MPH-38 for more info.

diff --git a/src/site/site.xml b/src/site/site.xml index 3306ecc4..4bdc825f 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -41,7 +41,7 @@ under the License. - + From 1a318fd460d2df904006e322ab92f4cca96744a3 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 11:59:45 +0000 Subject: [PATCH 2/6] Fix typo in describe-configuration.apt --- src/site/apt/examples/describe-configuration.apt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/site/apt/examples/describe-configuration.apt b/src/site/apt/examples/describe-configuration.apt index 64a6c00a..5e0327ca 100644 --- a/src/site/apt/examples/describe-configuration.apt +++ b/src/site/apt/examples/describe-configuration.apt @@ -172,7 +172,7 @@ For more information, run 'mvn help:describe [...] -Ddetail' ... +-----+ - If you don't provide a parameter a list is added with the mojos of the plugin and their + If you don't provide a parameter, a list is added with the mojos of the plugin and their descriptions: +-----+ From a3046555bb76e76d485ccbafe6267dc0582de524 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 12:01:13 +0000 Subject: [PATCH 3/6] active voice Reword description of the Maven Help Plugin for clarity. --- src/site/apt/index.apt.vm | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index bdb17e82..224f7036 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -29,10 +29,9 @@ ${project.name} - The Maven Help Plugin is used to get information about a project or the system. It can be used to get a - description of a particular plugin, including the plugin's goals with their parameters and component requirements, - the effective POM and effective settings of the current build, and the profiles applied to the current project being - built. + The Maven Help Plugin provides information about a project or the system. It can be used to + describe a particular plugin, including the plugin's goals with their parameters and component requirements, + the effective POM and effective settings of the current build, and the profiles applied to the current project. * Goals Overview From a96dde9f4eb367a9ccaa9da805bbf9ef7499e703 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 12:02:14 +0000 Subject: [PATCH 4/6] Clarify usage of artifact parameter in documentation --- src/site/apt/usage.apt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt index 03ff7ad3..dacf10d7 100644 --- a/src/site/apt/usage.apt +++ b/src/site/apt/usage.apt @@ -140,7 +140,7 @@ null object or invalid expression ... +-----+ - The <<>> parameter is used to evaluate expressions on the specified artifact's POM. If omitted, the evaluate goal uses the current + The <<>> parameter evaluates expressions on the specified artifact's POM. If omitted, the evaluate goal uses the current project's POM. You can ask for all Maven expressions listed in the Javadoc of the From c1d9ebc9fa3a7e7768c320e6dcf3b35c1d65c984 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 12:03:11 +0000 Subject: [PATCH 5/6] Update Help Plugin usage description for clarity --- src/site/apt/usage.apt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt index dacf10d7..eeb502a2 100644 --- a/src/site/apt/usage.apt +++ b/src/site/apt/usage.apt @@ -30,16 +30,16 @@ Usage - Below are the different goals and the basic configuration of the Help Plugin. + Below are the different goals and the minimal configuration of the Help Plugin. * The <<>> Goal - The <<<{{{./active-profiles-mojo.html}active-profiles}}>>> goal is used to discover which profiles have been - applied to the projects currently being built. For each project in the build session, it will output a list of - profiles which have been applied to that project, along with the source of the profile (POM, <<>> + The <<<{{{./active-profiles-mojo.html}active-profiles}}>>> goal lists the profiles that have been + applied to the projects currently being built. For each project in the build session, it outputs a list of + profiles that have been applied to that project, along with the source of the profile (POM, <<>> or <<>>). - You can execute this goal using the following command: + You can execute this goal with the following command: +-----+ # mvn help:active-profiles From 2b3b1240f56b0cf9fc89136bf99a88f67cbbb6dd Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 12:04:09 +0000 Subject: [PATCH 6/6] Remove FAQ about mvn help:active-profiles --- src/site/fml/faq.fml | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml index ddbb3b73..9aa8e5ae 100644 --- a/src/site/fml/faq.fml +++ b/src/site/fml/faq.fml @@ -33,13 +33,5 @@ under the License.

- - Why mvn help:active-profiles won't show the active profiles under Maven 2.1? - -

- See MPH-38 for more info. -

- - - \ No newline at end of file +