JDK-8319948 : jcmd man page needs to be updated
  • Type: Bug
  • Component: hotspot
  • Sub-Component: svc
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2023-11-13
  • Updated: 2024-06-13
  • Resolved: 2024-01-03
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 22 JDK 23
22Fixed 23 b04Fixed
Related Reports
Duplicate :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Description
jcmd manpage does not reflect its current state.

Missing in man page:

Compiler.memory (JDK-8317683: Add JIT memory statistics)

System.map + System.dump_map (JDK-8318636: Add jcmd to print annotated process memory map)

Thread.dump_to_file (JDK-8284161: Implementation of Virtual Threads (Preview))

VM.classes (JDK-8275775: Add jcmd VM.classes to print details of all classes)


Parameter change/Parameters added not reflected in man page:

GC.heap_dump (JDK-8306441: Two phase segmented heap dump)


Command removed is still mentioned in man page:

VM.print_touched_methods (JDK-8292890: Remove PrintTouchedMethodsAtExit and LogTouchedMethods)
Comments
Drat! Well spotted [~cjplummer]
13-06-2024

The following new line in jcmd.md: - `-F`: (Optional) File path (STRING, "vm_memory_map_<pid>.txt") Becomes the following in jcmd.l (The <pid> part is stripped) \f[V]-F\f[R]: (Optional) File path (STRING, \[dq]vm_memory_map_.txt\[dq]) Filed JDK-8334145.
12-06-2024

A pull request was submitted for review. URL: https://git.openjdk.org/jdk22/pull/27 Date: 2024-01-04 01:31:46 +0000
04-01-2024

Changeset: 028ec7e7 Author: David Holmes <dholmes@openjdk.org> Date: 2024-01-03 22:30:54 +0000 URL: https://git.openjdk.org/jdk/commit/028ec7e744f06cd8429b7b74d7b6f7020133aa94
03-01-2024

A pull request was submitted for review. URL: https://git.openjdk.org/jdk/pull/17213 Date: 2024-01-02 05:51:59 +0000
02-01-2024

We are also missing manpage information for - Compiler.CodeHeap_Analytics - Compiler.perfmap argument info - JFR.configure dumpath option - VM.metaspace chunkfreelist option There are other missing JFR.start options and the JFR.view command that I have filed JDK-8322812 for.
02-01-2024

Thanks for filing this Thomas! I think it will need to get broken up into sub-tasks for actioning as I don't think anyone has the time to go through and deal with all of these issues.
14-11-2023

Texts for recently added commands: ------------------ Compiler.memory [options] Print compilation footprint Impact: Medium - Pause time depends on number of compiled methods options: -H: Human readable format -s: Minimum memory size ----------------------------------- System.map [options] Prints an annotated process memory map of the VM process (Linux only). Impact: low options: -H: Human readable format ------------------------------------- System.map [options] Dumps an annotated process memory map to an output file (Linux only). Impact: low options: -H: Human readable format -F File path (default: "vm_memory_map_<pid>.txt")
13-11-2023