Skip to content

Clarify opaque strings paragraph in JDK toolchain docs #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
elharo wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Clarify opaque strings paragraph in JDK toolchain docs #189

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acc6dcc
Clarify opaque strings paragraph in JDK toolchain docs
elharo Jul 23, 2026
3b14698
Clarify Maven's interpretation of toolchain strings
elharo Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions src/site/apt/toolchains/jdk.apt.vm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,9 @@ JDK Toolchain
</configuration>
+---+

Aside from version, the definitions are opaque strings. Maven looks in <<<toolchains.xml>>>
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.
Aside from version, the values of <<<\<provides\>>>> elements are treated as opaque strings.
Maven looks in <<<toolchains.xml>>> for a toolchain that provides version=="1.8" and vendor=="temurin".
It does not interpret these strings semantically. For example, it does not validate that the jdkHome
directory actually contains a JDK matching the declared version and vendor.

All conditions need to be satisfied to find a toolchain.
Loading