JDK-8323687 : Update the jcmd manpage markdown source for Compiler.directives* with refresh
  • Type: Enhancement
  • Component: hotspot
  • Sub-Component: compiler
  • Affected Version: 23
  • Priority: P4
  • Status: Open
  • Resolution: Unresolved
  • Submitted: 2024-01-12
  • Updated: 2024-05-06
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.
Other
tbdUnresolved
Related Reports
Blocks :  
JDK-8309271 - A way to align already compiled methods with compiler directives
Blocks :  
JDK-8331749 - [REDO] A way to align already compiled methods with compiler directives
Description
After JDK-8309271 it will be necessary to update the src/jdk.jcmd/share/man/jcmd.1 man page, which means changes to the markdown source in the closed repository.

[options] are added to Compiler.directives_add, Compiler.directives_clear, Compiler.directives_remove with one optional '-r' flag; Compiler.directives_replace is added with parameters similar to Compiler.directives_add. So for instance there should be man for Compiler.directives_replace looking like

       Compiler.directives_replace [options] *arguments*
              Clear directives stack, and load new compiler directives from file.

              Impact: Low

              Permission: java.lang.management.ManagementPermission(monitor)

              arguments:

              filename: The name of the directives file (STRING, no default value)

              Note:

              The following options must be specified using either key or key=value syntax.

              options:

              -  -r: (Optional) Refresh affected methods (BOOLEAN, false)
Comments
Moved this to hotspot/compiler because the jcmd is about compiler directives.
28-02-2024
Also please ensure the manpage text and help text are consistent with each other.
14-01-2024
Note, options should be documented ahead of arguments (the help command has them the wrong way around).
14-01-2024