-
Notifications
You must be signed in to change notification settings - Fork 5.8k
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
Conversation
👋 Welcome back jjg! A progress list of the required criteria for merging this PR into |
@jonathan-gibbons The following label will be automatically applied to this pull request:
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
@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:
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 ➡️ To integrate this PR with the above commit message to the |
# Conflicts: # test/langtools/jdk/javadoc/doclet/testPackageDeprecation/TestPackageDeprecation.java # test/langtools/jdk/javadoc/doclet/testUseOption/TestUseOption.java
/integrate |
@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. |
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. Thesrc/
change is primarily in the recently-newHtmlIds
class, but there was one oversight in the recent work forHtmlIds
inSourceToHTMLConverter
, 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
Issue
Reviewers
Download
$ git fetch https://git.openjdk.java.net/jdk pull/2635/head:pull/2635
$ git checkout pull/2635