JDK-8300133: Use generalized see and link tags in core libs #12000

jddarcy · 2023-01-13T21:30:06Z

With generalized see and link tags that can refer to anchors (JDK-8200337), the see and link tags in core libraries should be updated to use this feature when possible. This PR covers such updates for java.base.

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-8300133: Use generalized see and link tags in core libs

Reviewers

Jonathan Gibbons (@jonathan-gibbons - Reviewer) ⚠️ Review applies to aa623f2a
Mandy Chung (@mlchung - Reviewer)
Naoto Sato (@naotoj - Reviewer)
Stuart Marks (@stuart-marks - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12000

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

Using diff file

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

bridgekeeper · 2023-01-13T21:45:35Z

👋 Welcome back darcy! 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 · 2023-01-13T21:49:22Z

@jddarcy The following labels will be automatically applied to this pull request:

core-libs
i18n
net
security

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

mlbridge · 2023-01-13T21:52:55Z

Webrevs

01: Full - Incremental (0e4d4e4b)
00: Full (aa623f2a)

jonathan-gibbons

Nice to see all those <a href="{@docRoot}/..." references go away.

openjdk · 2023-01-13T22:32:19Z

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

8300133: Use generalized see and link tags in core libs

Reviewed-by: jjg, mchung, naoto, smarks

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

2a46e07: 8286581: Make Java process DPI Aware if sun.java2d.dpiaware property is set
3ea0b8b: 8300489: Use ArraysSupport.vectorizedHashCode in j.l.CharacterName
fcbf9d0: 8300243: Replace NULL with nullptr in share/compiler/
c205cae: 8297851: Add devkit for RISC-V
c3242ee: 8298596: vmTestbase/nsk/sysdict/vm/stress/chain/chain008/chain008.java fails with "NoClassDefFoundError: Could not initialize class java.util.concurrent.ThreadLocalRandom"
b3684f4: 8153837: AArch64: Handle special cases for MaxINode & MinINode
754f6e6: 8300237: Minor improvements in MethodHandles
85d8bac: 8300166: Unused array allocation in ProcessPath.doProcessPath
c464ef1: 8292741: Convert JvmtiTagMapTable to ResourceHashtable
1aded82: 8300488: Incorrect usage of CATCH_BAD_ALLOC as a macro call
... and 66 more: https://git.openjdk.org/jdk/compare/4ec3659845486ee9f9227cdfb3f8b47f19462b19...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.

src/java.base/share/classes/java/util/ResourceBundle.java

naotoj

Changes in ResoruceBundle look good.

dfuch · 2023-01-16T15:06:25Z

src/java.base/share/classes/java/lang/CharSequence.java

@@ -73,8 +73,8 @@ public interface CharSequence {
     * indexing.
     *
     * <p>If the {@code char} value specified by the index is a
-     * <a href="{@docRoot}/java.base/java/lang/Character.html#unicode">surrogate</a>, the surrogate
-     * value is returned.
+     * {@linkplain Character##unicode surrogate}, the surrogate value


I didn't know about the ## trick. Is that a new feature to target an HTML anchor?

The CSR has a concise description: JDK-8294195 Generalize see and link tags for user-defined anchors

dfuch

Changes to InetAddressResolverProvider.java look good.

stuart-marks

Changes in collections look good. I think there are a bunch of other places where this could be used, but fixing up optional-restrictions is a good start.

jddarcy · 2023-01-18T18:52:50Z

/integrate

openjdk · 2023-01-18T18:54:10Z

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

2a46e07: 8286581: Make Java process DPI Aware if sun.java2d.dpiaware property is set
3ea0b8b: 8300489: Use ArraysSupport.vectorizedHashCode in j.l.CharacterName
fcbf9d0: 8300243: Replace NULL with nullptr in share/compiler/
c205cae: 8297851: Add devkit for RISC-V
c3242ee: 8298596: vmTestbase/nsk/sysdict/vm/stress/chain/chain008/chain008.java fails with "NoClassDefFoundError: Could not initialize class java.util.concurrent.ThreadLocalRandom"
b3684f4: 8153837: AArch64: Handle special cases for MaxINode & MinINode
754f6e6: 8300237: Minor improvements in MethodHandles
85d8bac: 8300166: Unused array allocation in ProcessPath.doProcessPath
c464ef1: 8292741: Convert JvmtiTagMapTable to ResourceHashtable
1aded82: 8300488: Incorrect usage of CATCH_BAD_ALLOC as a macro call
... and 66 more: https://git.openjdk.org/jdk/compare/4ec3659845486ee9f9227cdfb3f8b47f19462b19...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-01-18T18:54:31Z

@jddarcy Pushed as commit 7bf0d14.

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

JDK-8300133: Use generalized see and link tags in core libs

aa623f2

openjdk bot added the rfr Pull request is ready for review label Jan 13, 2023

openjdk bot added security security-dev@openjdk.org core-libs core-libs-dev@openjdk.org net net-dev@openjdk.org i18n i18n-dev@openjdk.org labels Jan 13, 2023

jonathan-gibbons approved these changes Jan 13, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jan 13, 2023

naotoj reviewed Jan 13, 2023

View reviewed changes

src/java.base/share/classes/java/util/ResourceBundle.java Outdated Show resolved Hide resolved

mlchung reviewed Jan 13, 2023

View reviewed changes

src/java.base/share/classes/java/util/ResourceBundle.java Outdated Show resolved Hide resolved

Fix typo found in code review.

0e4d4e4

mlchung approved these changes Jan 13, 2023

View reviewed changes

naotoj approved these changes Jan 13, 2023

View reviewed changes

dfuch reviewed Jan 16, 2023

View reviewed changes

stuart-marks approved these changes Jan 18, 2023

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Jan 18, 2023

openjdk bot closed this Jan 18, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jan 18, 2023

jddarcy deleted the JDK-8300133 branch June 10, 2023 20:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JDK-8300133: Use generalized see and link tags in core libs #12000

JDK-8300133: Use generalized see and link tags in core libs #12000

jddarcy commented Jan 13, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jan 13, 2023

openjdk bot commented Jan 13, 2023

mlbridge bot commented Jan 13, 2023 •

edited

Loading

jonathan-gibbons left a comment

openjdk bot commented Jan 13, 2023 •

edited

Loading

naotoj left a comment

dfuch Jan 16, 2023

RogerRiggs Jan 16, 2023

dfuch left a comment

stuart-marks left a comment

jddarcy commented Jan 18, 2023

openjdk bot commented Jan 18, 2023

openjdk bot commented Jan 18, 2023

JDK-8300133: Use generalized see and link tags in core libs #12000

JDK-8300133: Use generalized see and link tags in core libs #12000

Conversation

jddarcy commented Jan 13, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Jan 13, 2023

openjdk bot commented Jan 13, 2023

mlbridge bot commented Jan 13, 2023 • edited Loading

Webrevs

jonathan-gibbons left a comment

Choose a reason for hiding this comment

openjdk bot commented Jan 13, 2023 • edited Loading

naotoj left a comment

Choose a reason for hiding this comment

dfuch Jan 16, 2023

Choose a reason for hiding this comment

RogerRiggs Jan 16, 2023

Choose a reason for hiding this comment

dfuch left a comment

Choose a reason for hiding this comment

stuart-marks left a comment

Choose a reason for hiding this comment

jddarcy commented Jan 18, 2023

openjdk bot commented Jan 18, 2023

openjdk bot commented Jan 18, 2023

jddarcy commented Jan 13, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jan 13, 2023 •

edited

Loading

openjdk bot commented Jan 13, 2023 •

edited

Loading