-
Notifications
You must be signed in to change notification settings - Fork 5.8k
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-8315464: Uncouple AllClassesIndexWriter from IndexBuilder #15746
Conversation
👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into |
Webrevs
|
...k.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AllClassesIndexWriter.java
Outdated
Show resolved
Hide resolved
…mats/html/AllClassesIndexWriter.java Remove whitespace Co-authored-by: Andrey Turbanov <turbanoff@gmail.com>
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.
Approved.
I assume all tests pass, and that JDK API docs are not affected.
@hns 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 162 new commits pushed to the
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 |
Thanks for reviewing!
Yes to both. |
/integrate |
Going to push as commit 6b8261b.
Your commit was automatically rebased without conflicts. |
My original intention with this cleanup was to keep using `[Html]IndexBuilder' for both the "All Classes" and the main index, but just improve separation of code and naming of classes. However, I then discovered two things:
IndexBuilder
toAllClassesIndexWriter
just added about a dozen lines of code to the latter, while makingIndexBuilder
much simpler by removing its dual purpose.toolkit.util.IndexBuilder
andformats.html.HtmlIndexBuilder
, although seemingly random at first sight, actually reflects the usage of functionality provided by the respective packages. Although with a single output format the separation between these packages is not as important as it used to be, it is still nice to keep things separated.Based on these two findings, I decided to pull the "All Classes" code into "AllClassesIndexWriter", but maintain the implementation of
[Html]IndexBuilder
across the two classes/packages. Although the baseIndexBuilder
class is technically able to function on its own without the HTML-specific enhancements, I made the class abstract in order to point out that the HTML enhancements inHtmlIndexBuilder
are actually essential for our us.Progress
Issue
Reviewers
Reviewing
Using
git
Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/15746/head:pull/15746
$ git checkout pull/15746
Update a local copy of the PR:
$ git checkout pull/15746
$ git pull https://git.openjdk.org/jdk.git pull/15746/head
Using Skara CLI tools
Checkout this PR locally:
$ git pr checkout 15746
View PR using the GUI difftool:
$ git pr show -t 15746
Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/15746.diff
Webrev
Link to Webrev Comment