On Wed, 10 Jan 2024 21:40:08 GMT, Chris Plummer <cjplum...@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) @plummercj the manpage output should be consistent with the help output and AFAICS the help does not state that there is a default filename either for `Compiler.perfmap` or `VM.cds`. I think the help text has to be updated as well, in which case the VM.cds change should be split out separately IMO. ------------- Changes requested by dholmes (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/17359#pullrequestreview-1814333469
