On Wed, 16 Oct 2024 09:12:56 GMT, Kevin Walls <kev...@openjdk.org> wrote:
>> Man page update for jcmd. >> >> Add updates for the filename options/arguments affected by: >> 8334492: DiagnosticCommands (jcmd) should accept %p in output filenames and >> substitute PID >> >> Also: >> In the initial "command" summary, remove the text about "If the pid is 0.." >> as it is completely duplicated very shortly afterwards in the COMMANDS FOR >> JCMD section. >> >> In Description: >> Each diagnostic command has its own set of options and arguments . >> >> Added "options and" because arguments and options are different and this can >> still be confusing. Mentioning them as being different may help. >> >> Similarly, added a short section describing that jcmds "may take options and >> arguments" and further spelling out that options are name=value and >> arguments are not, as this can still be confusing. > > Kevin Walls has updated the pull request with a new target base due to a > merge or a rebase. The incremental webrev excludes the unrelated changes > brought in by the merge/rebase. The pull request contains three additional > commits since the last revision: > > - Update JFR commands for FILE > - Merge remote-tracking branch 'upstream/master' into > 8337276_jcmd_pid_manpage > - 8337276: jcmd man page update for PID in output filenames src/jdk.jcmd/share/man/jcmd.1 line 974: > 972: \f[I]filename\f[R]: (Optional) Name of the shared archive to be dumped. > 973: If %p is specified in the filename, it is expanded to the JVM\[aq]s PID. > 974: (FILE, \[dq]java_pid%p_<subcmd>.jsa\[dq]) The paragraph below this goes into details on how the default path is generated even though it is implied by the above help. We don't do this extra explanation for other places where the filename has a default, so probably not needed here, but I suppose it doesn't hurt either. Also, two paragraphs below is a discussions about absolute paths that also applies to all other uses of filename. If it is necessary here, then that implies it is necessary in the other locations too. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/20401#discussion_r1803858444
