RFR: 8359123: Misleading examples in jmod man page [v3]

[Iris Clark]

On Mon, 16 Jun 2025 19:59:06 GMT, Ana Maria Mihalceanu <duke at openjdk.org> wrote:

>> Please review my PR. This PR includes the following:
>> 
>> - [x] Fix a small typo in a word and copyright.
>> - [x] Enhance description for `--target-platform`.
>> - [x] Rearrange `jmod create` example from basic to complex.
>
> Ana Maria Mihalceanu has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Enhance --target-platform explanation.

Your updates look good.

I believe you've addressed @AlanBateman 's comments, but he should confirm.

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"

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...".

-------------

PR Review: https://git.openjdk.org/jdk/pull/25772#pullrequestreview-2936389012
PR Review Comment: https://git.openjdk.org/jdk/pull/25772#discussion_r2152734413
PR Review Comment: https://git.openjdk.org/jdk/pull/25772#discussion_r2152722640