Integrated: 8323546: Cleanup jcmd docs for Compiler.perfmap and VM.cds filename parameter

[Chris Plummer]

On Wed, 10 Jan 2024 21:40:08 GMT, Chris Plummer <cjplummer at openjdk.org> wrote:

> The jcmd docs for Compiler.perfmap currently say:
> 
>     - *filename*: (Optional) The name of the map file (STRING, no default value)
> 
> However, there is a default, so not only should that be made more clear in the above, but also some descriptive text as to how the default is generated should be added.
> 
> VM.cds has a similar issue, but already has the descriptive text, so just the "no default value" part needs to be fixed.
> 
> Another change needed is to consistently use *filename* (italics) instead of `filename` (monospace). Note this is how html formatting is done. For the man page formatting, *filename* does no formatting and `filename` is displayed in color if supported. Personally I prefer `filename`, but it seems that there is already a strong precedence for using italics in the *arguments* list. For example:
> 
>     *arguments*:
> 
>     - *flag name*: The name of the flag that you want to set (STRING, no
>         default value)
> 
>     - *string value*: (Optional) The value that you want to set (STRING, no
>         default value)

This pull request has now been integrated.

Changeset: edfee7f3
Author:    Chris Plummer <cjplummer at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/edfee7f348349cfa55a9acd92d3bbd9e0cd4f07f
Stats:     40 lines in 3 files changed: 28 ins; 0 del; 12 mod

8323546: Cleanup jcmd docs for Compiler.perfmap and VM.cds filename parameter

Reviewed-by: dholmes, sspitsyn, iklam

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

PR: https://git.openjdk.org/jdk/pull/17359