RFR: 8359123: Misleading examples in jmod man page [v3]
Ana Maria Mihalceanu
duke at openjdk.org
Tue Jun 17 17:08:17 UTC 2025
On Tue, 17 Jun 2025 16:51:19 GMT, Iris Clark <iris at openjdk.org> wrote:
>> Ana Maria Mihalceanu has updated the pull request incrementally with one additional commit since the last revision:
>>
>> Enhance --target-platform explanation.
>
> src/jdk.jlink/share/man/jmod.md line 182:
>
>> 180:
>> 181: `--target-platform` *platform*
>> 182: : Specifies the target platform when creating a JMOD file intended
>
> Suggest (nit) from: "the target platform when creating a JMOD file" to "the target platform of a JMOD file"
Modified according to review 😄 .
> src/jdk.jlink/share/man/jmod.md line 240:
>
>> 238: Create a platform-specific JMOD file bundling compiled classes, configuration files,
>> 239: native commands and libraries, header files, man pages, and metadata including the
>> 240: main class, module version, and target platform details:
>
> Sorry to be picky, but I just noticed that the order of the options in the description and the example don't match. Also, since you're choosing the "all" option for this example, you should consider beginning the sentence with just "Create a JMOD file...".
Not a problem at all, is important to keep the order both in explanation and command. I modified accordingly. 😄
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/25772#discussion_r2152761067
PR Review Comment: https://git.openjdk.org/jdk/pull/25772#discussion_r2152762065
More information about the core-libs-dev
mailing list