JDK-8323546 : Cleanup jcmd docs for Compiler.perfmap and VM.cds filename parameter
  • Type: Enhancement
  • Component: core-svc
  • Sub-Component: tools
  • Affected Version: 23
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2024-01-10
  • Updated: 2024-06-10
  • Resolved: 2024-01-23
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
JDK 23
23 b07Fixed
Related Reports
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Description
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)


Comments
Changeset: edfee7f3 Author: Chris Plummer <cjplummer@openjdk.org> Date: 2024-01-23 20:33:49 +0000 URL: https://git.openjdk.org/jdk/commit/edfee7f348349cfa55a9acd92d3bbd9e0cd4f07f
23-01-2024

> Shouldn't this be filed under hotspot->svc? jcmd is not a core-libs tool. It's not core-libs, it is core-svc. Most of the jcmd bugs end up here, but there are also some under hotspot->svc and hotspot->runtime. There's is definitely a consistency issue here. I think the main thing we've settled on is adding the "jcmd" label (and in general any core-svc->tools CR will have a label for the tool in question). > Or, given this involves a change to the functional code, then hotspot->compiler for Compiler.perfmap and and seperate hotspot->runtime issue for VM.cds We've discussed moving jcmd bugs to appropriate hotspot subcomponent, but in the end never settled on doing this. It's a good idea in that it gets the CR directed to the proper group, but for reasons I don't understand the preference is to keep the CRs filed with some sort of serviceability component or subcomponent.
16-01-2024

Shouldn't this be filed under hotspot->svc? jcmd is not a core-libs tool. Or, given this involves a change to the functional code, then hotspot->compiler for Compiler.perfmap and and seperate hotspot->runtime issue for VM.cds
15-01-2024

The manpage output should be consistent with the help text, which is also missing the default filename description. I think both should be addressed at the same time - suggesting the VM.cds change is split out.
10-01-2024

A pull request was submitted for review. URL: https://git.openjdk.org/jdk/pull/17359 Date: 2024-01-10 21:40:08 +0000
10-01-2024