Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8225049: Bad -Xlog example in -Xlog:help, online documentation, JEP #20934

Closed
wants to merge 1 commit into from

Conversation

jaikiran
Copy link
Member

@jaikiran jaikiran commented Sep 10, 2024

Can I get a review of this change which fixes a typo in the java spec documentation?

As noted in the issue, the example used there -Xlog:gc=trace:file=gctrace.txt:uptimemillis,pids:filecount=5,filesize=1024 doesn't work and instead of pids, it should have been pid.

The updated example in this PR now works fine with:

java -Xlog:gc=trace:file=gctrace.txt:uptimemillis,pid:filecount=5,filesize=1024 -version

and the generated trace file contains the process id:

[1ms][85757] MarkStackSize: 4096k  MarkStackSizeMax: 524288k
[5ms][85757] Using G1
[5ms][85757] ConcGCThreads: 2 offset 16
[5ms][85757] ParallelGCThreads: 8
[5ms][85757] Initialize mark stack with 4096 chunks, maximum 524288

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-8225049: Bad -Xlog example in -Xlog:help, online documentation, JEP (Bug - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 20934

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Sep 10, 2024

👋 Welcome back jpai! 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
Copy link

openjdk bot commented Sep 10, 2024

@jaikiran 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:

8225049: Bad -Xlog example in -Xlog:help, online documentation, JEP

Reviewed-by: dholmes

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 17 new commits pushed to the master branch:

  • 6fd043f: 8339789: Use index and definition tags in AnnotatedElement
  • 30645f3: 8338395: Add test coverage for instantiating NativePRNG with SecureRandomParameters
  • c8e64cb: 8283779: Clarify API documentation of NetworkInterface with respect to configuration changes
  • 9243104: 8335444: Generalize implementation of AndNode mul_ring
  • 3352522: 8338894: Deprecate jhsdb debugd for removal
  • be0dca0: 8339698: x86 unused andw/orw/xorw/addw encoding could be removed
  • 64a79d8: 8335625: Update Javadoc for GetCpuLoad
  • c246ede: 8339799: Reduce work done in j.l.invoke bytecode generators
  • 38441b3: 8339677: [vectorapi] YYYXXXVector::withLaneHelper and laneHelper should use Double::doubleToRawLongBits/Float::floatToRawIntBits
  • fb51c1e: 8339837: Remove unused BootstrapMethodsInvokers.isLambdaMetafactoryCondyBSM
  • ... and 7 more: https://git.openjdk.org/jdk/compare/56387a09810a3204ed820885e0ff0b26408be59d...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 openjdk bot added the rfr Pull request is ready for review label Sep 10, 2024
@openjdk
Copy link

openjdk bot commented Sep 10, 2024

@jaikiran 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

Copy link
Member

@dholmes-ora dholmes-ora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good and trivial

Thanks

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Sep 10, 2024
@dholmes-ora
Copy link
Member

It looks like the -Xlog:help output was already fixed.

@jaikiran
Copy link
Member Author

Thank you for the review David.

It looks like the -Xlog:help output was already fixed.

Right, as you already found out, it got fixed in https://bugs.openjdk.org/browse/JDK-8215398.

@jaikiran
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Sep 11, 2024

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

  • 9785e19: 8339638: Update vmTestbase/nsk/jvmti/FieldWatch tests to use virtual thread factory
  • 6fd043f: 8339789: Use index and definition tags in AnnotatedElement
  • 30645f3: 8338395: Add test coverage for instantiating NativePRNG with SecureRandomParameters
  • c8e64cb: 8283779: Clarify API documentation of NetworkInterface with respect to configuration changes
  • 9243104: 8335444: Generalize implementation of AndNode mul_ring
  • 3352522: 8338894: Deprecate jhsdb debugd for removal
  • be0dca0: 8339698: x86 unused andw/orw/xorw/addw encoding could be removed
  • 64a79d8: 8335625: Update Javadoc for GetCpuLoad
  • c246ede: 8339799: Reduce work done in j.l.invoke bytecode generators
  • 38441b3: 8339677: [vectorapi] YYYXXXVector::withLaneHelper and laneHelper should use Double::doubleToRawLongBits/Float::floatToRawIntBits
  • ... and 8 more: https://git.openjdk.org/jdk/compare/56387a09810a3204ed820885e0ff0b26408be59d...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Sep 11, 2024
@openjdk openjdk bot closed this Sep 11, 2024
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 11, 2024
@openjdk
Copy link

openjdk bot commented Sep 11, 2024

@jaikiran Pushed as commit 0764323.

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

@jaikiran jaikiran deleted the 8225049 branch September 11, 2024 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

2 participants