Skip to content
This repository has been archived by the owner before Nov 9, 2022. It is now read-only.

8260194: Update the documentation for -Xcheck:jni #52

Closed
wants to merge 4 commits into from

Conversation

dholmes-ora
Copy link
Member

@dholmes-ora dholmes-ora commented Jun 15, 2021

Please review this update to the -Xcheck:jni description in the java manpage.

For ease of reading there was a temporary commit of the generated java.html page. This can be viewed here:

https://htmlpreview.github.io/?https://github.com/openjdk/jdk17/blob/4f336dd3985b654dc3fbacabdcfccf590ea918e5/java.html

A preemptive note on the punctuation of the lists. The first and second level level list items are all complete sentences and so end with a period. The third level list items are phrases, not full sentences and so do not end with a period. :)

Thanks,
David


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8260194: Update the documentation for -Xcheck:jni

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk17 pull/52/head:pull/52
$ git checkout pull/52

Update a local copy of the PR:
$ git checkout pull/52
$ git pull https://git.openjdk.java.net/jdk17 pull/52/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 52

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk17/pull/52.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Jun 15, 2021

👋 Welcome back dholmes! 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 Jun 15, 2021

@dholmes-ora 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
  • 2d
  • awt
  • beans
  • build
  • compiler
  • core-libs
  • hotspot
  • hotspot-compiler
  • hotspot-gc
  • hotspot-jfr
  • hotspot-runtime
  • i18n
  • javadoc
  • jdk
  • jmx
  • kulla
  • net
  • nio
  • security
  • serviceability
  • shenandoah
  • sound
  • swing

@dholmes-ora
Copy link
Member Author

dholmes-ora commented Jun 15, 2021

/label add hotspot-runtime

@openjdk openjdk bot added the hotspot-runtime hotspot-runtime-dev@openjdk.java.net label Jun 15, 2021
@openjdk
Copy link

openjdk bot commented Jun 15, 2021

@dholmes-ora
The hotspot-runtime label was successfully added.

@dholmes-ora dholmes-ora marked this pull request as ready for review Jun 15, 2021
@openjdk openjdk bot added the rfr Pull request is ready for review label Jun 15, 2021
@mlbridge
Copy link

mlbridge bot commented Jun 15, 2021

Webrevs

Copy link
Contributor

@coleenp coleenp left a comment

Looks good. Just a question:

"A jFieldID, or jMethodID, is detected as being invalid. For example:"

Is this the casing of these used in JNI?

@openjdk
Copy link

openjdk bot commented Jun 16, 2021

@dholmes-ora 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:

8260194: Update the documentation for -Xcheck:jni

Reviewed-by: coleenp, hseigel

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

  • 9ad19f7: 8256934: C2: assert(C->live_nodes() <= C->max_node_limit()) failed: Live Node limit exceeded limit
  • 19f5fab: 8268861: Disable Windows-Aarch64 build in GitHub Actions
  • 59de99d: 8267271: Fix gc/arguments/TestNewRatioFlag.java expectedNewSize calculation
  • 4d545a1: 8267988: C2: assert(!addp->is_AddP() || addp->in(AddPNode::Base)->is_top() || addp->in(AddPNode::Base) == n->in(AddPNode::Base)) failed: Base pointers must match (addp 1301)
  • b18de6c: 8268851: ProblemList jdk/jfr/event/gc/detailed/TestEvacuationFailedEvent.java on linux-X64
  • 10068c1: 8268830: ProblemList 3 serviceability/dcmd/framework tests with ZGC on win-x64
  • 788b309: 8268768: idea.sh has been updated in surprising and incompatible ways
  • 9ac0609: 8268828: ProblemList compiler/intrinsics/VectorizedMismatchTest.java on win-x64
  • fe7a44d: 8268723: Problem list SA core file tests on OSX when using ZGC
  • 31a055e: 8268736: Use apiNote in AutoCloseable.close javadoc
  • ... and 5 more: https://git.openjdk.java.net/jdk17/compare/a5bf5e0e5f6c18b51e398ab81ed9d0a29bf31b6f...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 Jun 16, 2021
@dholmes-ora
Copy link
Member Author

dholmes-ora commented Jun 16, 2021

Thanks for the review Coleen!

Good catch on the incorrect case for jfieldID and jmethodID - now fixed.

David

Copy link
Member

@hseigel hseigel left a comment

Changes look good!
Harold

@dholmes-ora
Copy link
Member Author

dholmes-ora commented Jun 16, 2021

Thanks for the review Harold!

@dholmes-ora
Copy link
Member Author

dholmes-ora commented Jun 16, 2021

/integrate

@openjdk
Copy link

openjdk bot commented Jun 16, 2021

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

  • ee03bc6: 8268863: ProblemList serviceability/sa/TestJmapCoreMetaspace.java on linux-x64 with ZGC
  • f0f2178: 8268909: ProblemList jdk/jfr/api/consumer/streaming/TestLatestEvent.java on win-x64
  • 54f5ffe: 8259338: Add expiry exception for identrustdstx3 alias to VerifyCACerts.java test
  • 2c7e47e: 8268774: Residual logging output written to STDOUT, not STDERR
  • 8ea0606: 8268714: [macos-aarch64] 7 java/net/httpclient/websocket tests failed
  • 38dbe05: 8268901: JDK-8268768 missed removing two files
  • 9ad19f7: 8256934: C2: assert(C->live_nodes() <= C->max_node_limit()) failed: Live Node limit exceeded limit
  • 19f5fab: 8268861: Disable Windows-Aarch64 build in GitHub Actions
  • 59de99d: 8267271: Fix gc/arguments/TestNewRatioFlag.java expectedNewSize calculation
  • 4d545a1: 8267988: C2: assert(!addp->is_AddP() || addp->in(AddPNode::Base)->is_top() || addp->in(AddPNode::Base) == n->in(AddPNode::Base)) failed: Base pointers must match (addp 1301)
  • ... and 11 more: https://git.openjdk.java.net/jdk17/compare/a5bf5e0e5f6c18b51e398ab81ed9d0a29bf31b6f...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Jun 16, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jun 16, 2021
@openjdk
Copy link

openjdk bot commented Jun 16, 2021

@dholmes-ora Pushed as commit 9f7851b.

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

@dholmes-ora dholmes-ora deleted the 8260194 branch Jun 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
hotspot-runtime hotspot-runtime-dev@openjdk.java.net integrated Pull request has been integrated
3 participants