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

8262883: doccheck: Broken links in java.base #3491

Closed

Conversation

Michael-Mc-Mahon
Copy link
Member

@Michael-Mc-Mahon Michael-Mc-Mahon commented Apr 14, 2021

Hi,

Could I get the following trivial doc changes reviewed please, caused by:

  • broken tags in MethodHandles referring to package.html instead of package-summary.html

  • references to a package level #unixdomain anchor that no longer exists.

  • a tag missing a "../" in SocketChannel

Thanks,

Michael


Progress

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

Issue

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 3491

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 14, 2021

👋 Welcome back michaelm! 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 Apr 14, 2021
@openjdk
Copy link

openjdk bot commented Apr 14, 2021

@Michael-Mc-Mahon The following labels will be automatically applied to this pull request:

  • core-libs
  • net

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.

@openjdk openjdk bot added core-libs core-libs-dev@openjdk.org net net-dev@openjdk.org labels Apr 14, 2021
@mlbridge
Copy link

mlbridge bot commented Apr 14, 2021

Webrevs

@Michael-Mc-Mahon
Copy link
Member Author

/label add nio

@openjdk openjdk bot added the nio nio-dev@openjdk.org label Apr 14, 2021
@openjdk
Copy link

openjdk bot commented Apr 14, 2021

@Michael-Mc-Mahon
The nio label was successfully added.

@openjdk
Copy link

openjdk bot commented Apr 14, 2021

@Michael-Mc-Mahon 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:

8262883: doccheck: Broken links in java.base

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

  • 75b039a: 8263970: Manual test javax/swing/JTextField/JapaneseReadingAttributes/JapaneseReadingAttributes.java failed
  • f5b2f08: 8257836: Add additional test cases to TestSyncOnValueBasedClassEvent.java
  • 27dd88b: 8262957: (fs) Fail fast in UnixFileStore.isExtendedAttributesEnabled

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 Pull request is ready to be integrated label Apr 14, 2021
@Michael-Mc-Mahon
Copy link
Member Author

/integrate

@openjdk openjdk bot closed this Apr 14, 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 Apr 14, 2021
@openjdk
Copy link

openjdk bot commented Apr 14, 2021

@Michael-Mc-Mahon Since your change was applied there have been 3 commits pushed to the master branch:

  • 75b039a: 8263970: Manual test javax/swing/JTextField/JapaneseReadingAttributes/JapaneseReadingAttributes.java failed
  • f5b2f08: 8257836: Add additional test cases to TestSyncOnValueBasedClassEvent.java
  • 27dd88b: 8262957: (fs) Fail fast in UnixFileStore.isExtendedAttributesEnabled

Your commit was automatically rebased without conflicts.

Pushed as commit 4661690.

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

@Michael-Mc-Mahon Michael-Mc-Mahon deleted the 8262883-docheck branch April 14, 2021 15:01
@@ -172,7 +172,7 @@ public static DatagramChannel open() throws IOException {
* java.nio.channels.spi.SelectorProvider} object. The channel will not be
* connected.
*
* @apiNote <a href="package-summary.html#unixdomain">Unix domain</a> sockets
* @apiNote {@linkplain java.net.UnixDomainSocketAddress Unix domain} sockets
Copy link
Contributor

Choose a reason for hiding this comment

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

The parameter to this method is a ProtocolFamily and maybe this note should be say that StandardProtocolFamily#UNIX is not supported.

Copy link
Member Author

Choose a reason for hiding this comment

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

Okay, reasonable suggestion. I was a bit quick integrating. I will file a new issue to update the spec as suggested.

@RogerRiggs
Copy link
Contributor

Integrating less than an hour after the PR is started seems to be a bit too quick to allow useful input.
Perhaps even for 'trivial' changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated net net-dev@openjdk.org nio nio-dev@openjdk.org
Development

Successfully merging this pull request may close these issues.

4 participants