From dd6b83dd00f9f5b0c00eb61877caae59abb61bd4 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Thu, 23 Jul 2026 11:51:49 +0000 Subject: [PATCH 1/3] Fix grammar, typos, and awkward phrasing in site docs - custom.apt: its provides -> it provides - index.apt.vm: Toolchains Plugins -> Toolchain Plugin (singular) - index.apt.vm: discover and selects -> discovers and selects - index.apt.vm: let user copy/paste -> lets the user copy and paste - usage.apt.vm: plugin that require -> plugin that requires - jdk.apt.vm: In plugin's selection -> In the plugin configuration - jdk.apt.vm: clarify jdkHome is child of configuration element - jdk.apt.vm: add missing articles (The, the) - jdk-discovery.apt.vm: reword awkward useJdk sentence --- src/site/apt/index.apt.vm | 6 +++--- src/site/apt/toolchains/custom.apt | 2 +- src/site/apt/toolchains/jdk-discovery.apt.vm | 2 +- src/site/apt/toolchains/jdk.apt.vm | 6 +++--- src/site/apt/usage.apt.vm | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index e6ba754..c7e88f6 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -25,7 +25,7 @@ ${project.name} - The Toolchains Plugins enables sharing tool configuration across plugins; + The Toolchains Plugin enables sharing tool configuration across plugins; for example, to make sure that plugins like compiler, surefire, and javadoc all use the same JDK for execution, independently from JRE used to run Maven itself. @@ -35,13 +35,13 @@ ${project.name} on an internal heuristic which tries to detect JDKs from known locations. Read about the {{{./toolchains/jdk-discovery.html}JDK discovery mechanism}} for more information. This mechanism is to be used with the goal: - * {{{./select-jdk-toolchain-mojo.html}toolchains:select-jdk-toolchain}} discover and selects a matching JDK toolchain. + * {{{./select-jdk-toolchain-mojo.html}toolchains:select-jdk-toolchain}} discovers and selects a matching JDK toolchain. Two associated helper goals are also provided: * {{{./display-discovered-jdk-toolchains-mojo.html}toolchains:display-discovered-jdk-toolchains}} displays discovered JDK toolchains to the console, - * {{{./generate-jdk-toolchains-xml-mojo.html}toolchains:generate-jdk-toolchains-xml}} can be used to generate discovered JDKs in <<>> format and let user copy/paste. + * {{{./generate-jdk-toolchains-xml-mojo.html}toolchains:generate-jdk-toolchains-xml}} can be used to generate discovered JDKs in <<>> format and let the user copy and paste. The previous <<>> goal is still available for JDK and {{{./toolchains/custom.html}other types}} of toolchains: diff --git a/src/site/apt/toolchains/custom.apt b/src/site/apt/toolchains/custom.apt index 6fdb931..d4b75d9 100644 --- a/src/site/apt/toolchains/custom.apt +++ b/src/site/apt/toolchains/custom.apt @@ -46,7 +46,7 @@ Custom Toolchains * an implementation of this interface. Extending {{{/ref/current/maven-core/apidocs/org/apache/maven/toolchain/DefaultToolchain.html}<<>>}} - is strongly encouraged, since its provides + is strongly encouraged, since it provides {{{/ref/current/maven-core/apidocs/org/apache/maven/toolchain/ToolchainPrivate.html}<<>>}}, which is an internal requirement, diff --git a/src/site/apt/toolchains/jdk-discovery.apt.vm b/src/site/apt/toolchains/jdk-discovery.apt.vm index 692dc9a..c1b9bac 100644 --- a/src/site/apt/toolchains/jdk-discovery.apt.vm +++ b/src/site/apt/toolchains/jdk-discovery.apt.vm @@ -121,7 +121,7 @@ mvn toolchains:select-jdk-toolchain -Dtoolchain.jdk.version="[17,)" compile * <<>> / <<>>: the name of an environment variable that the JDK toolchain must match - The <<>> can be used to define whether the current JDK can be used if it matches the requirements. + The <<>> property controls whether the current JDK is used when it matches the requirements. * Sorting diff --git a/src/site/apt/toolchains/jdk.apt.vm b/src/site/apt/toolchains/jdk.apt.vm index 04f2ac1..589f7e1 100644 --- a/src/site/apt/toolchains/jdk.apt.vm +++ b/src/site/apt/toolchains/jdk.apt.vm @@ -33,13 +33,13 @@ JDK Toolchain Predefined <<<\>>> identification tokens, for requirement matching in plugin configuration, are: - * "<<>>" marks the version of the JDK in <<>>. In plugin's selection, this can be either a single version or a version range. + * "<<>>" marks the version of the JDK in <<>>. In the plugin configuration, this can be either a single version or a version range. * Other tokens are accepted, but only exact matches are supported. [] - In <<>>, there is only one <<<\>>> element named "<<>>". It designates the root directory + In <<>>, the only child of the <<<\>>> element is <<>>. It designates the root directory of a JDK installation. * Sample <<<~/.m2/toolchains.xml>>> setup @@ -121,6 +121,6 @@ JDK Toolchain for a toolchain that provides version=="1.8" and vendor=="temurin". It does not know or care what these strings mean. It does not, for instance, concern itself with whether the jdkHome configured by the toolchain that satisfies version=="1.8" and vendor=="temurin" is JDK 8 from the Temurin project, - or JDK 21 from Oracle. JDK toolchain only checks that directory exists. + or JDK 21 from Oracle. The JDK toolchain only checks that the directory exists. All conditions need to be satisfied to find a toolchain. diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm index 276ca2e..b8c0cd7 100644 --- a/src/site/apt/usage.apt.vm +++ b/src/site/apt/usage.apt.vm @@ -45,7 +45,7 @@ Usage With the <<>> toolchain, for example, instead of being stuck with the JDK used to run Maven, all plugins can use the same other JDK instance without hardcoding absolute paths into the <<>> and without configuring every - plugin that require a path to JDK tools. + plugin that requires a path to JDK tools. * The <<>> goal From d5e2954341f1b9c20f31a49cf29ddabec4972a92 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Thu, 23 Jul 2026 11:57:27 +0000 Subject: [PATCH 2/3] Improve clarity of generate JDK toolchains XML description Clarified the description of the generate JDK toolchains XML goal to improve readability. --- src/site/apt/index.apt.vm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index c7e88f6..707f057 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -41,7 +41,7 @@ ${project.name} * {{{./display-discovered-jdk-toolchains-mojo.html}toolchains:display-discovered-jdk-toolchains}} displays discovered JDK toolchains to the console, - * {{{./generate-jdk-toolchains-xml-mojo.html}toolchains:generate-jdk-toolchains-xml}} can be used to generate discovered JDKs in <<>> format and let the user copy and paste. + * {{{./generate-jdk-toolchains-xml-mojo.html}toolchains:generate-jdk-toolchains-xml}} can be used to generate discovered JDKs in <<>> format so the user can copy and paste. The previous <<>> goal is still available for JDK and {{{./toolchains/custom.html}other types}} of toolchains: From d7b0ebbec237d749405af2852cc8ffaab040ca0c Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Mon, 27 Jul 2026 10:44:12 +0000 Subject: [PATCH 3/3] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- src/site/apt/toolchains/jdk-discovery.apt.vm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/site/apt/toolchains/jdk-discovery.apt.vm b/src/site/apt/toolchains/jdk-discovery.apt.vm index c1b9bac..fbf8be8 100644 --- a/src/site/apt/toolchains/jdk-discovery.apt.vm +++ b/src/site/apt/toolchains/jdk-discovery.apt.vm @@ -121,7 +121,7 @@ mvn toolchains:select-jdk-toolchain -Dtoolchain.jdk.version="[17,)" compile * <<>> / <<>>: the name of an environment variable that the JDK toolchain must match - The <<>> property controls whether the current JDK is used when it matches the requirements. + The <<>> / <<>> property controls how the current JDK is handled (IfMatch, IfSame, Never) when it matches the requirements. * Sorting