Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-11 Thread Chris Plummer
> 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 generate

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-12 Thread Serguei Spitsyn
On Fri, 12 Jan 2024 02:07:47 GMT, Chris Plummer 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,

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-13 Thread David Holmes
On Fri, 12 Jan 2024 02:07:47 GMT, Chris Plummer 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,

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-13 Thread David Holmes
On Fri, 12 Jan 2024 10:27:53 GMT, Serguei Spitsyn wrote: >> Chris Plummer has updated the pull request incrementally with one additional >> commit since the last revision: >> >> fix default filename issue > > src/hotspot/share/services/diagnosticCommand.cpp line 866: > >> 864: const char*

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-13 Thread Chris Plummer
On Sun, 14 Jan 2024 01:05:52 GMT, David Holmes wrote: > And I still think the VM.CDS change show have its own issue (if not PR). Yes, and I asked why that is the case. The VM.cds changes are very much related to the Compiler.perfmap changes. I think it's actually correct to do them together, n

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-13 Thread Chris Plummer
On Sun, 14 Jan 2024 01:03:14 GMT, David Holmes wrote: >> src/hotspot/share/services/diagnosticCommand.cpp line 866: >> >>> 864: const char* filename = _filename.value(); >>> 865: if (strncmp(filename, DEFAULT_PERFMAP_FILENAME, >>> strlen(DEFAULT_PERFMAP_FILENAME)) == 0) { >>> 866: fil

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-14 Thread David Holmes
On Sun, 14 Jan 2024 01:28:48 GMT, Chris Plummer wrote: > > And I still think the VM.CDS change show have its own issue (if not PR). > > Yes, and I asked why that is the case. The VM.cds changes are very much > related to the Compiler.perfmap changes. I think it's actually correct to do > them

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-14 Thread David Holmes
On Sun, 14 Jan 2024 01:26:25 GMT, Chris Plummer wrote: >> I only expected to see a change to the help string, I don't understand why >> the actual Dcmd is being modified here! ??? > > The default value for the argument is what gets displayed in the help text. > For example: > > > ThreadDumpTo

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-14 Thread Ioi Lam
On Mon, 15 Jan 2024 01:29:47 GMT, David Holmes wrote: >> The default value for the argument is what gets displayed in the help text. >> For example: >> >> >> ThreadDumpToFileDCmd::ThreadDumpToFileDCmd(outputStream* output, bool heap) : >>DCmdWithPars

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-14 Thread David Holmes
On Mon, 15 Jan 2024 04:28:15 GMT, Ioi Lam wrote: >> Ugghh! So the help text is an actual stringification of the actual default >> value of the "field", whereas in this case the real default value comes from >> passing null to `CodeCache::write_perf_map`. So we need this hack to deal >> with th

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-15 Thread Ioi Lam
On Mon, 15 Jan 2024 07:32:31 GMT, David Holmes wrote: >> This check is problematic: >> >> >> if (strncmp(filename, DEFAULT_PERFMAP_FILENAME, >> strlen(DEFAULT_PERFMAP_FILENAME)) == 0) >> >> >> Because it cannot tell whether `filename` was explicitly given by the user. >> As a result, if the

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-15 Thread David Holmes
On Mon, 15 Jan 2024 08:13:10 GMT, Ioi Lam wrote: >> @iklam but IIUC that does not address the issue of updationg the help output. > > My suggestion is to be used in combination with this change: > > > _filename("filename", "Name of the map file", "STRING", false, > DEFAULT_PERFMAP_FILENAME) >

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-15 Thread Chris Plummer
On Tue, 16 Jan 2024 01:47:51 GMT, David Holmes wrote: >> My suggestion is to be used in combination with this change: >> >> >> _filename("filename", "Name of the map file", "STRING", false, >> DEFAULT_PERFMAP_FILENAME) >> >> >> So the help message will be printed as: >> >> >> *filename*:

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-15 Thread Chris Plummer
On Mon, 15 Jan 2024 01:31:33 GMT, David Holmes wrote: > > > And I still think the VM.CDS change show have its own issue (if not PR). > > > > > > Yes, and I asked why that is the case. The VM.cds changes are very much > > related to the Compiler.perfmap changes. I think it's actually correct to

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-15 Thread David Holmes
On Tue, 16 Jan 2024 02:21:56 GMT, Chris Plummer wrote: >> But that only works if `init_value` is never called, else `is_set` will be >> true. This seems a rather fragile way to have the "default string" available >> for the help command, but avoiding actually using it as a default value. >> >>

Re: RFR: 8323546: Clarify docs for Compiler.perfmap filename parameter, and other misc related jcmd doc cleanups [v4]

2024-01-15 Thread David Holmes
On Tue, 16 Jan 2024 02:25:32 GMT, Chris Plummer wrote: > Sorry I missed your response, although I still honestly don't know when/where > it was. No I'm sorry, I can't find it either. I must have forgotten to click the right button at some point. :( My concern was that once we were changing fu