Port and update the documentation #941
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bukama
requested changes
Jul 1, 2025
Contributor
Bukama
left a comment
Bukama
left a comment
There was a problem hiding this comment.
Thanks for the PR!
Most comments are small things I think :)
src/site/markdown/index.md
Outdated
| To provide you with better understanding on some usages of the Compiler Plugin, | ||
| you can take a look into the following examples: | ||
|
|
||
| * [Compile using A Different JDK](./examples/compile-using-different-jdk.html) |
Contributor
There was a problem hiding this comment.
Suggested change
| * [Compile using A Different JDK](./examples/compile-using-different-jdk.html) | |
| * [Compile Using A Different JDK](./examples/compile-using-different-jdk.html) |
Contributor
Author
There was a problem hiding this comment.
We have inconsistencies in the lower/upper case titles not only in this list, but also in the title of various examples/*.md files. I'm often confused about what the English rules are on this matter, so I don't really know in which direction to go.
…sor. Avoid the use of a property that may not be defined on the user's machine.
… with no change in the text. We can use the format (APT versus Markdown) as a way to identify which files have been updated from Maven 3 to Maven 4.
…ed anymore. The new page is incomplete as it does not yet mention the replacement (`target/javac-test.args` is not really the replacement). This is because the code generating the replacement has not yet been merged. It is pending argreement to reach on mailing list.
…owing changes: - Make more visible that users compiling for Java 9+ have nothing special to do. - Remove the text about how to use toolchain for compiling with Java 9+. It was obsolete since Maven 4 requires Java 17. - Adapt the text about how to use toolchain for compiling with a old JDK.
… the following changes: * Remove the mention of `compilerVersion`, which is not supported anymore in plugin version 4. The version is either managed by the toolchain, or included in the path to the executable.
…he following changes: * Insist that `--release` should be used instead. * Replace "JRE" term by "JDK" since the former is no longer used. * Use more recent Java version in the example. * Remove the sentence saying that the `release` property is replaced by `-source` and `-target` on Java 8 or earlier. This feature has been removed in plugin 4 since it requires Java 17.
… following changes: * Version 4 of the Maven compiler plugin additionally accepts the 'k', 'M' and 'G' suffixes.
…ignificant change in the text.
… changes: * Put the current example in a "Maven 3" section. * Add a "Maven 4" section.
…changes:
A significant change is that large parts of the explanation about JEP-238
("forward compatibility problem") have been removed for the following reasons:
* We assume that multi-releases is now known well enough.
* The explanation used an obsolete example (Maven running on Java 6).
* The section was showing how to NOT use multi-releases (using reflection),
which may be more a distraction than a help for the purpose of this page.
Removed most of the patterns for building a multi-releases project with Maven 3,
because many of them were referencing external web sites which are not available
anymore, or with content not obviously about multi-releases.
In particular, removed the following references:
* Reference to Animal Sniffer plugin, which is replaced by the `--release` option.
* Page http://word-bits.flurg.com/multrelease-jars/ is not available anymore (404).
* Page http://in.relation.to/2017/02/13/building-multi-release-jars-with-maven/ is blocked (security).
* Page http://www.russgold.net/sw/2018/04/easier-than-it-looks/ refers to above-cited blocked page.
Replaced "Maven module" by "Maven subproject" term for avoiding confusion with JPMS modules.
Removed the "all IDEs can only have one JDK per Maven Project, whereas with multi release you want to specify it per source folder."
This is not exactly true. We do not necessarily want different JDK, only different values for the `--release` option.
Added a section about multi-releases JAR projects with Maven 4.
* Remove the sentence saying that Java 8 is the default version. Version 4 of the plugin does not set a default version anymore.
desruisseaux
force-pushed
the
documentation
branch
from
61aab8d to
9e2d877
Compare
slachiewicz
approved these changes
Jul 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Convert all APT files except
usage.apt.vmfrom the APT format to Markdown, together with changes in the text. Each file is moved by a separated commit with a message that summarize the changes. Broadly, the changes are: