Skip to content

Fix env property example in JDK discovery docs#186

Open
elharo wants to merge 1 commit into
apache:masterfrom
elharo:fix-docs-env-property
Open

Fix env property example in JDK discovery docs#186
elharo wants to merge 1 commit into
apache:masterfrom
elharo:fix-docs-env-property

Conversation

@elharo

@elharo elharo commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

The example for selecting a toolchain by environment variable incorrectly used <toolchain.jdk.version> instead of <toolchain.jdk.env>. Also fixes malformed XML closing tag.

The example for selecting a toolchain by environment variable used
<toolchain.jdk.version>JAVA17_HOME</toolchain.jdk.version> but this
should be <toolchain.jdk.env>. Also fix the malformed XML closing tag.
@elharo elharo added the documentation Improvements or additions to documentation label Jul 23, 2026
@elharo
elharo requested a review from Copilot July 23, 2026 11:59

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the JDK discovery documentation examples to correctly demonstrate selecting a toolchain via an environment variable, aligning the documented property name with the plugin’s actual parameter.

Changes:

  • Fixes the example property name from toolchain.jdk.version to toolchain.jdk.env for env-var based selection.
  • Fixes a malformed XML closing tag in the env-var example snippet.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 98 to +101
+---+
<properties>
<toolchain.jdk.version>JAVA17_HOME</toolchain.jdk.version>
<properties>
<toolchain.jdk.env>JAVA17_HOME</toolchain.jdk.env>
</properties>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants