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

8262893: Enable more doclint checks in javadoc build #2799

Closed
wants to merge 1 commit into from

Conversation

jddarcy
Copy link
Member

@jddarcy jddarcy commented Mar 2, 2021

With recent cleanups, several doclint categories have been cleared across the JDK and should be enabled in the javadoc build to make sure they stay clean.

Local docs build completes with this stricter set of checks.


Progress

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

Issue

  • JDK-8262893: Enable more doclint checks in javadoc build

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk pull/2799/head:pull/2799
$ git checkout pull/2799

@bridgekeeper
Copy link

bridgekeeper bot commented Mar 2, 2021

👋 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 openjdk bot added the rfr Pull request is ready for review label Mar 2, 2021
@openjdk
Copy link

openjdk bot commented Mar 2, 2021

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

  • build

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 build build-dev@openjdk.org label Mar 2, 2021
@mlbridge
Copy link

mlbridge bot commented Mar 2, 2021

Webrevs

Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Choose a reason for hiding this comment

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

👍

@openjdk
Copy link

openjdk bot commented Mar 3, 2021

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

8262893: Enable more doclint checks in javadoc build

Reviewed-by: jjg, erikj

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

  • 40bdf52: 8262096: Vector API fails to work due to VectorShape initialization exception
  • 93ffe6a: 8262892: minor typo in implSpec comment
  • 4f4d0f5: 8261969: SNIHostName should check if the encoded hostname conform to RFC 3490
  • c92f3bc: 8262876: Shenandoah: Fix comments regarding VM_ShenandoahOperation inheritances

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 Mar 3, 2021
@liach
Copy link
Member

liach commented Mar 3, 2021

Should html be enabled? That doclint is still checking against html 4, while currently javadoc generates html 5 outputs.

@jddarcy
Copy link
Member Author

jddarcy commented Mar 3, 2021

/integrate

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

openjdk bot commented Mar 3, 2021

@jddarcy Since your change was applied there have been 4 commits pushed to the master branch:

  • 40bdf52: 8262096: Vector API fails to work due to VectorShape initialization exception
  • 93ffe6a: 8262892: minor typo in implSpec comment
  • 4f4d0f5: 8261969: SNIHostName should check if the encoded hostname conform to RFC 3490
  • c92f3bc: 8262876: Shenandoah: Fix comments regarding VM_ShenandoahOperation inheritances

Your commit was automatically rebased without conflicts.

Pushed as commit c9097a6.

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

@openjdk
Copy link

openjdk bot commented Mar 3, 2021

@jddarcy The command integrate can only be used in open pull requests.

@jddarcy jddarcy deleted the 8262893 branch June 10, 2021 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build build-dev@openjdk.org integrated Pull request has been integrated
4 participants