8335479: JFR: Missing documentation for -XX:StartFlightRecording

[egahlin]

Could I have a review of updates to the -XX:StartFlightRecording option for JFR.

Testing: tier1

Thanks
Erik

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8335479: JFR: Missing documentation for -XX:StartFlightRecording (Bug - P3)

Reviewers

• Markus Grönlund (@mgronlun - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/19992/head:pull/19992
$ git checkout pull/19992

Update a local copy of the PR:
$ git checkout pull/19992
$ git pull https://git.openjdk.org/jdk.git pull/19992/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 19992

View PR using the GUI difftool:
$ git pr show -t 19992

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/19992.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back egahlin! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@egahlin This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8335479: JFR: Missing documentation for -XX:StartFlightRecording

Reviewed-by: mgronlun

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 24 new commits pushed to the master branch:

• 153b12b: 8331560: Refactor Hotspot container detection code so that subsystem delegates to controllers
• 685e587: 8334816: compiler/c2/irTests/TestIfMinMax.java fails after 8334629
• dd74e7f: 8335147: Serial: Refactor TenuredGeneration::promote
• a537e87: 8335530: Java file extension missing in AuthenticatorTest
• 4060b35: 8335298: Fix -Wzero-as-null-pointer-constant warning in G1CardSetContainers
• 9046d7a: 8335390: C2 MergeStores: wrong result with Unsafe
• 318d9ac: 8335369: Fix -Wzero-as-null-pointer-constant warnings in ImmutableOopMapBuilder
• 5fe07b3: 5021949: JSplitPane setEnabled(false) shouldn't be partially functional
• ee4720a: 8333306: gc/arguments/TestParallelGCErgo.java fails when largepage are enabled
• 2f4f6cc: 8317721: RISC-V: Implement CRC32 intrinsic
• ... and 14 more: https://git.openjdk.org/jdk/compare/486aa11e74d0772ba84c2adc3c62fc1fcbf52604...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[openjdk]

@egahlin To determine the appropriate audience for reviewing this pull request, one or more labels corresponding to different subsystems will normally be applied automatically. However, no automatic labelling rule matches the changes in this pull request. In order to have an "RFR" email sent to the correct mailing list, you will need to add one or more applicable labels manually using the /label pull request command.

Applicable Labels

• build
• client
• compiler
• core-libs
• graal
• hotspot
• hotspot-compiler
• hotspot-gc
• hotspot-jfr
• hotspot-runtime
• i18n
• ide-support
• javadoc
• jdk
• jmx
• kulla
• net
• nio
• security
• serviceability
• shenandoah

[egahlin]

/label add hotspot-jfr

[openjdk]

@egahlin
The hotspot-jfr label was successfully added.

[mlbridge]

Webrevs

• 00: Full (46bf0fc4)

[egahlin]

/integrate

[openjdk]

Going to push as commit 68ffec9.
Since your change was applied there have been 51 commits pushed to the master branch:

• 9a91865: 8335395: G1: Verification does not detect references into Free regions
• 13b782c: 8334554: RISC-V: verify & fix perf of string comparison
• 8aaec37: 8322475: Extend printing for System.map
• 19a8a2b: 8335618: Serial: Remove unused definitions in SerialHeap
• cf4f2b5: 8332517: G1: Refactor G1AllocRegion
• 5a8af2b: 8335615: Clean up left-overs from 8317721
• 6923a51: 8335607: Serial: Remove unused collection_attempt_is_safe
• 5866b16: 8335411: RISC-V: Optimize encode_heap_oop when oop is not null
• 6db4c6a: 8335536: Fix assertion failure in IdealGraphPrinter when append is true
• 350f9c1: 8322812: Manpage for jcmd is missing JFR.view command
• ... and 41 more: https://git.openjdk.org/jdk/compare/486aa11e74d0772ba84c2adc3c62fc1fcbf52604...master

Your commit was automatically rebased without conflicts.

[openjdk]

@egahlin Pushed as commit 68ffec9.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

[egahlin]

/backport openjdk/jdk:jdk23

[openjdk]

@egahlin the backport was successfully created on the branch backport-egahlin-68ffec98-jdk23 in my personal fork of openjdk/jdk. To create a pull request with this backport targeting openjdk/jdk:jdk23, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 68ffec98 from the openjdk/jdk repository.

The commit being backported was authored by Erik Gahlin on 3 Jul 2024 and was reviewed by Markus Grönlund.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk:

$ git fetch https://github.com/openjdk-bots/jdk.git backport-egahlin-68ffec98-jdk23:backport-egahlin-68ffec98-jdk23
$ git checkout backport-egahlin-68ffec98-jdk23
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk.git backport-egahlin-68ffec98-jdk23