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

8322321: Add man page doc for -XX:+VerifySharedSpaces #17152

Conversation

iklam
Copy link
Member

@iklam iklam commented Dec 19, 2023

VerifySharedSpaces was disabled in JDK-8221478 by default. We should add an entry in the "java" man page about the intended use for this flag.


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-8322321: Add man page doc for -XX:+VerifySharedSpaces (Enhancement - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17152

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Dec 19, 2023

👋 Welcome back iklam! 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 openjdk bot added the rfr Pull request is ready for review label Dec 19, 2023
@openjdk
Copy link

openjdk bot commented Dec 19, 2023

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

@iklam
Copy link
Member Author

iklam commented Dec 19, 2023

/label hotspot

@openjdk openjdk bot added the hotspot hotspot-dev@openjdk.org label Dec 19, 2023
@openjdk
Copy link

openjdk bot commented Dec 19, 2023

@iklam
The hotspot label was successfully added.

@mlbridge
Copy link

mlbridge bot commented Dec 19, 2023

Webrevs

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.

Text is generally fine. A couple of typos need fixing.

@@ -1579,6 +1579,15 @@ Specifies the path and name of the class data sharing (CDS) archive file
See \f[B]Application Class Data Sharing\f[R].
.RE
.TP
\f[V]-XX:+VerifySharedSpaces\f[R]
If this option is specified, the JVM will load a CDS archive file only
if it passes an integrity check based on CRC32 checkums.
Copy link
Member

Choose a reason for hiding this comment

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

typo: checkums

\f[V]-XX:+VerifySharedSpaces\f[R]
If this option is specified, the JVM will load a CDS archive file only
if it passes an integrity check based on CRC32 checkums.
The purpose of this flag is to check for unintentional damages of CDS
Copy link
Member

Choose a reason for hiding this comment

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

s/damages of/damage to/

\f[V]-XX:+VerifySharedSpaces\f[R]
If this option is specified, the JVM will load a CDS archive file only
if it passes an integrity check based on CRC32 checksums.
The purpose of this flag is to check for unintentional damages to CDS
Copy link
Member

Choose a reason for hiding this comment

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

s/damages/damage/

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.

Looks good.

Only one review needed for this doc change.

Thanks.

@openjdk
Copy link

openjdk bot commented Dec 20, 2023

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

8322321: Add man page doc for -XX:+VerifySharedSpaces

Reviewed-by: dholmes, ccheung

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

  • 51be857: 8322166: Files.isReadable/isWritable/isExecutable expensive when file does not exist
  • 0f8e4e0: 8311218: fatal error: stuck in JvmtiVTMSTransitionDisabler::VTMS_transition_disable
  • 6313223: 8315856: RISC-V: Use Zacas extension for cmpxchg
  • 3bc5679: 8322309: Fix an inconsistancy in spacing style in spec.gmk.template
  • be49dab: 8321619: Generational ZGC: ZColorStoreGoodOopClosure is only valid for young objects
  • ac968c3: 8319451: PhaseIdealLoop::conditional_move is too conservative
  • 0ad6c9e: 8322255: Generational ZGC: ZPageSizeMedium should be set before MaxTenuringThreshold
  • fff2e58: 8322195: RISC-V: Minor improvement of MD5 instrinsic
  • 7b4d62c: 8322300: Remove redundant arg in PSAdaptiveSizePolicy::adjust_promo_for_pause_time
  • 76637c5: 8321648: Integral gather optimized mask computation.
  • ... and 1 more: https://git.openjdk.org/jdk/compare/808a03927c153581cbece93a4f5a4f8242b61ef5...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 ready Pull request is ready to be integrated label Dec 20, 2023
@iklam
Copy link
Member Author

iklam commented Dec 20, 2023

Thanks @dholmes-ora @calvinccheung for the review
/integrate

@openjdk
Copy link

openjdk bot commented Dec 20, 2023

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

  • 97db670: 8321688: Build on linux with GCC 7.5.0 fails after 8319577
  • 51be857: 8322166: Files.isReadable/isWritable/isExecutable expensive when file does not exist
  • 0f8e4e0: 8311218: fatal error: stuck in JvmtiVTMSTransitionDisabler::VTMS_transition_disable
  • 6313223: 8315856: RISC-V: Use Zacas extension for cmpxchg
  • 3bc5679: 8322309: Fix an inconsistancy in spacing style in spec.gmk.template
  • be49dab: 8321619: Generational ZGC: ZColorStoreGoodOopClosure is only valid for young objects
  • ac968c3: 8319451: PhaseIdealLoop::conditional_move is too conservative
  • 0ad6c9e: 8322255: Generational ZGC: ZPageSizeMedium should be set before MaxTenuringThreshold
  • fff2e58: 8322195: RISC-V: Minor improvement of MD5 instrinsic
  • 7b4d62c: 8322300: Remove redundant arg in PSAdaptiveSizePolicy::adjust_promo_for_pause_time
  • ... and 2 more: https://git.openjdk.org/jdk/compare/808a03927c153581cbece93a4f5a4f8242b61ef5...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Dec 20, 2023

@iklam Pushed as commit f7dc257.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hotspot hotspot-dev@openjdk.org integrated Pull request has been integrated
3 participants