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

JDK-8276674 : Malformed Javadoc inline tags in JDK source #6443

Closed
wants to merge 2 commits into from

Conversation

tprinzing
Copy link
Contributor

@tprinzing tprinzing commented Nov 18, 2021


Progress

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

Issue

  • JDK-8276674: Malformed Javadoc inline tags in JDK source

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 6443

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

Using diff file

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

@bridgekeeper bridgekeeper bot added the oca label Nov 18, 2021
@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Nov 18, 2021

Hi @tprinzing, welcome to this OpenJDK project and thanks for contributing!

We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing /signed in a comment in this pull request.

If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user tprinzing" as summary for the issue.

If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing /covered in a comment in this pull request.

@openjdk
Copy link

@openjdk openjdk bot commented Nov 18, 2021

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

  • compiler
  • core-libs
  • hotspot-runtime
  • kulla

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 hotspot-runtime core-libs compiler kulla labels Nov 18, 2021
@tprinzing tprinzing changed the title Fixed @code and @link in some javadoc for JDK-8276674 JDK-8276674 : Fixed @code and @link in some javadoc Nov 18, 2021
@tprinzing tprinzing changed the title JDK-8276674 : Fixed @code and @link in some javadoc JDK-8276674 : Malformed Javadoc inline tags in JDK source in java/util/stream Nov 18, 2021
@tprinzing
Copy link
Contributor Author

@tprinzing tprinzing commented Nov 18, 2021

/covered

@bridgekeeper bridgekeeper bot added the oca-verify label Nov 18, 2021
@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Nov 18, 2021

Thank you! Please allow for a few business days to verify that your employer has signed the OCA. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Remarkable to have not been noticed for so long!

@bridgekeeper bridgekeeper bot removed oca oca-verify labels Nov 24, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Nov 24, 2021

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

8276674: Malformed Javadoc inline tags in JDK source

Reviewed-by: jjg, rriggs, prappo, bchristi

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

  • e0f1fc7: 8277358: Accelerate CRC32-C
  • 73a9654: 8276806: Use Objects.checkFromIndexSize where possible in java.base
  • 30087cc: 8275342: Change nested classes in java.prefs to static nested classes
  • 669c90e: 8278099: two sun/security/pkcs11/Signature tests failed with AssertionError
  • 4f15be2: 8277965: Enclosing instance optimization affects serialization
  • 8f196a2: 8278037: Clean up PPC32 related code in C1
  • 8b042d1: 8257856: Make ClassFileVersionsTest.java robust to JDK version updates
  • ad1ff27: 8277422: tools/jar/JarEntryTime.java fails with modified time mismatch
  • 7c4ef3a: 8277985: G1: Compare max_parallel_refinement_threads to UINT_MAX
  • dc2abc9: 8278080: Add --with-cacerts-src='user cacerts folder' to enable deterministic cacerts generation
  • ... and 16 more: https://git.openjdk.java.net/jdk/compare/09522db5aa9503131381bbb4fe3f2eae829645ce...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@jonathan-gibbons, @RogerRiggs, @pavelrappo, @bchristi-git) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added ready rfr labels Nov 24, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Nov 24, 2021

Webrevs

@pavelrappo
Copy link
Member

@pavelrappo pavelrappo commented Nov 25, 2021

Remarkable to have not been noticed for so long!

Remarkable, but not too surprising: the PR consists of source files and tests that are not part of the API Documentation.

Copy link
Member

@pavelrappo pavelrappo left a comment

Looks good.

* If the AST node appears in the same line number as the main diagnostic, the line is information is omitted.
* Otherwise both line and column information is included, using the format @{code line:col}".
* Otherwise both line and column information is included, using the format {@code line:col}".
Copy link
Member

@pavelrappo pavelrappo Nov 25, 2021

Choose a reason for hiding this comment

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

Not a showstopper by any means. But while you are at it, maybe you could also fix this?

Suggested change
* If the AST node appears in the same line number as the main diagnostic, the line is information is omitted.
* Otherwise both line and column information is included, using the format @{code line:col}".
* Otherwise both line and column information is included, using the format {@code line:col}".
* If the AST node appears in the same line number as the main diagnostic, the line information is omitted.
* Otherwise both line and column information is included, using the format {@code line:col}.

Copy link
Member

@pavelrappo pavelrappo Nov 30, 2021

Choose a reason for hiding this comment

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

This part was recently integrated in #6602. I assume there will be a trivial merge conflict to resolve.

@pavelrappo
Copy link
Member

@pavelrappo pavelrappo commented Dec 1, 2021

Given that this PR affects files that aren't rooted under java/util/stream, I would either rename the PR or exclude the unrelated files. If this PR is going to sit there for some more time, I would prefer the latter. This is because the PR has already conflicted with a few other issues related to malformed javadoc tags (e.g. JDK-8276683 and JDK-8276684).

So either rename and integrate soon, or exclude the unrelated files.

@tprinzing tprinzing changed the title JDK-8276674 : Malformed Javadoc inline tags in JDK source in java/util/stream JDK-8276674 : Malformed Javadoc inline tags in JDK source Dec 2, 2021
Copy link
Member

@bchristi-git bchristi-git left a comment

Looks good. Thanks for renaming, per Pavel's suggestion. I can sponsor this.

@tprinzing
Copy link
Contributor Author

@tprinzing tprinzing commented Dec 2, 2021

/integrate

@openjdk openjdk bot added the sponsor label Dec 2, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Dec 2, 2021

@tprinzing
Your change (at version 56f578f) is now ready to be sponsored by a Committer.

@bchristi-git
Copy link
Member

@bchristi-git bchristi-git commented Dec 2, 2021

/sponsor

@openjdk
Copy link

@openjdk openjdk bot commented Dec 2, 2021

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

  • e0f1fc7: 8277358: Accelerate CRC32-C
  • 73a9654: 8276806: Use Objects.checkFromIndexSize where possible in java.base
  • 30087cc: 8275342: Change nested classes in java.prefs to static nested classes
  • 669c90e: 8278099: two sun/security/pkcs11/Signature tests failed with AssertionError
  • 4f15be2: 8277965: Enclosing instance optimization affects serialization
  • 8f196a2: 8278037: Clean up PPC32 related code in C1
  • 8b042d1: 8257856: Make ClassFileVersionsTest.java robust to JDK version updates
  • ad1ff27: 8277422: tools/jar/JarEntryTime.java fails with modified time mismatch
  • 7c4ef3a: 8277985: G1: Compare max_parallel_refinement_threads to UINT_MAX
  • dc2abc9: 8278080: Add --with-cacerts-src='user cacerts folder' to enable deterministic cacerts generation
  • ... and 16 more: https://git.openjdk.java.net/jdk/compare/09522db5aa9503131381bbb4fe3f2eae829645ce...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Dec 2, 2021
@openjdk openjdk bot added integrated and removed ready rfr sponsor labels Dec 2, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Dec 2, 2021

@bchristi-git @tprinzing Pushed as commit 652b5f8.

💡 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
compiler core-libs hotspot-runtime integrated kulla
5 participants