RFR: 8314029: Add file name parameter to Compiler.perfmap [v4]

[Chris Plummer]

On Tue, 21 Nov 2023 20:42:47 GMT, Chris Plummer <cjplummer at openjdk.org> wrote:

>> src/jdk.jcmd/share/man/jcmd.1 line 1:
>> 
>>> 1: .\" Copyright (c) 2012, 2023, Oracle and/or its affiliates. All rights reserved.
>> 
>> The actual markdown source for this file needs to be updated with these changes. Those sources are not open-source unfortunately. Please either coordinate to get the sources updated with an Oracle developer as part of this PR (they will integrate the internal part), or else please defer this to a subtask and let an Oracle developer update the source and output at the same time. Thanks.
>
> I filed JDK-8320556 to update the closed source. It's assigned to me. I'll do the update after these changes are pushed. In the meantime I'll make sure the current jcmd.1 changes are correct and match the closed changes I'll be making.

I've applied the doc changes in the CSR to our closed markup file and generated a new jcmd.1 file with it. You can apply this diff to this PR to get the open changes checked in:


diff --git a/src/jdk.jcmd/share/man/jcmd.1 b/src/jdk.jcmd/share/man/jcmd.1
index 4157cf600e1..af8d3e61b86 100644
--- a/src/jdk.jcmd/share/man/jcmd.1
+++ b/src/jdk.jcmd/share/man/jcmd.1
@@ -178,11 +178,21 @@ Prints all compiled methods in code cache that are alive.
 Impact: Medium
 .RE
 .TP
-\f[V]Compiler.perfmap\f[R] (Linux only)
+\f[V]Compiler.perfmap\f[R] [\f[I]arguments\f[R]] (Linux only)
 Write map file for Linux perf tool.
 .RS
 .PP
 Impact: Low
+.PP
+\f[I]arguments\f[R]:
+.IP [bu] 2
+\f[V]filename\f[R]: (Optional) Name of the map file (STRING, no default
+value)
+.PP
+If \f[V]filename\f[R] is not specified, a default file name is chosen
+using the pid of the target JVM process.
+For example, if the pid is \f[V]12345\f[R], then the default
+\f[V]filename\f[R] will be \f[V]/tmp/perf-12345.map\f[R].
 .RE
 .TP
 \f[V]Compiler.queue\f[R]

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

PR Review Comment: https://git.openjdk.org/jdk/pull/15871#discussion_r1408505466