Skip to content

JDK-8261976: Normalize id's used by the standard doclet #2635

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

Closed
wants to merge 2 commits into from

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Feb 18, 2021

This is a conceptually simple change to ensure that all "id"s generated by the standard doclet use - to separate the words of the id. The src/ change is primarily in the recently-new HtmlIds class, but there was one oversight in the recent work for HtmlIds in SourceToHTMLConverter, which is now fixed.

It's notable now that all "static" ids generated by the doclet contain at least one -, and so never conflict with the id for any field name, which cannot contain a -.

The tests are updated; all tests pass, of course, including the implicit link check that is default on in almost all tests. A full doc check run on a full JDK docs build did not reveal any unexpected problems. It wasn't clear which tests to nominate with a bug number, and so (somewhat unusually) I have added the bug number to all affected tests.


Progress

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

Issue

  • JDK-8261976: Normalize id's used by the standard doclet

Reviewers

Download

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

@bridgekeeper
Copy link

bridgekeeper bot commented Feb 18, 2021

👋 Welcome back jjg! 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 Feb 18, 2021
@openjdk
Copy link

openjdk bot commented Feb 18, 2021

@jonathan-gibbons The following label will be automatically applied to this pull request:

  • javadoc

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 javadoc javadoc-dev@openjdk.org label Feb 18, 2021
@mlbridge
Copy link

mlbridge bot commented Feb 19, 2021

Webrevs

Copy link
Member

@hns hns left a comment

Choose a reason for hiding this comment

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

Looks good!

@openjdk
Copy link

openjdk bot commented Feb 22, 2021

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

8261976: Normalize id's used by the standard doclet

Reviewed-by: hannesw

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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 Feb 22, 2021
# Conflicts:
#	test/langtools/jdk/javadoc/doclet/testPackageDeprecation/TestPackageDeprecation.java
#	test/langtools/jdk/javadoc/doclet/testUseOption/TestUseOption.java
@jonathan-gibbons
Copy link
Contributor Author

/integrate

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

openjdk bot commented Feb 23, 2021

@jonathan-gibbons Pushed as commit c30a90b.

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

@jonathan-gibbons jonathan-gibbons deleted the htmlIds branch June 30, 2021 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Development

Successfully merging this pull request may close these issues.

2 participants