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

8274071: Clean up java.lang.ref comments and documentation #5609

Closed
wants to merge 1 commit into from

Conversation

pavelrappo
Copy link
Member

@pavelrappo pavelrappo commented Sep 21, 2021

This PR fixes an inline comment typo and reduces "overlinking" in a doc comment in java.lang.ref.Reference. Overlinking happens because the reachabilityFence method:

  • Links package-summary.html#reachability twice.
  • Refers to JLS 12.6 twice: once from a block tag and once from an inline tag.

Progress

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

Issue

  • JDK-8274071: Clean up java.lang.ref comments and documentation

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5609

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

Using diff file

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

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Sep 21, 2021

👋 Welcome back prappo! 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 label Sep 21, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Sep 21, 2021

@pavelrappo The following label will be automatically applied to this pull request:

  • core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the core-libs label Sep 21, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Sep 21, 2021

Webrevs

@openjdk
Copy link

@openjdk openjdk bot commented Sep 21, 2021

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

8274071: Clean up java.lang.ref comments and documentation

Reviewed-by: rriggs, kbarrett, mchung, iris, lancea

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

  • 0fc47e9: 8266666: Implementation for snippets
  • 6d91a3e: 8269039: Disable SHA-1 Signed JARs
  • 42d5d2a: 8274056: JavaAccessibilityUtilities leaks JNI objects
  • 57df0db: 8270873: JFR: Catch DirectoryIteratorException when scanning for .jfr files
  • 111d5e1: 8273915: Create 'nosafepoint' rank
  • 7acec3f: 8236505: Mark jdk/editpad/EditPadTest.java as @headful

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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 label Sep 21, 2021
Copy link

@kimbarrett kimbarrett left a comment

Looks good.

@pavelrappo
Copy link
Member Author

@pavelrappo pavelrappo commented Sep 22, 2021

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Sep 22, 2021

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

  • 71788c6: 8271287: jdk/jshell/CommandCompletionTest.java fails with "lists don't have the same size expected"
  • ba7d550: 8270139: jshell InternalError crash for import of @repeatable followed by unresolved ref
  • aefd4ac: 8258734: jdk/jfr/event/oldobject/TestClassLoaderLeak.java failed with "RuntimeException: Could not find class leak"
  • d245a8c: 8274069: Clean up g1ParScanThreadState a bit
  • 3f73ca7: 8274068: Rename G1ScanInYoungSetter to G1SkipCardEnqueueSetter
  • 7f78803: 8273961: jdk/nio/zipfs/ZipFSTester.java fails if file path contains '+' character
  • 51085b5: 8274054: Add custom enqueue calls during reference processing
  • c77ebe8: 8274060: C2: Incorrect computation after JDK-8273454
  • d9872ba: 8273590: Move helper classes in G1 post evacuation sub tasks to cpp files
  • 688b3fe: 8274070: Rectify problemlist platform for failing test on macos12
  • ... and 12 more: https://git.openjdk.java.net/jdk/compare/afd218d39a3125fcea50968edef6e6cfbacfff50...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Sep 22, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Sep 22, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Sep 22, 2021

@pavelrappo Pushed as commit c6df3c9.

💡 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
core-libs integrated
6 participants