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-8315464: Uncouple AllClassesIndexWriter from IndexBuilder #15746

Closed
wants to merge 2 commits into from

Conversation

hns
Copy link
Member

@hns hns commented Sep 14, 2023

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:

  • The "All Classes" page is so simple to build that it doesn't justify using a complex builder class. In fact, moving the necessary functionality from IndexBuilder to AllClassesIndexWriter just added about a dozen lines of code to the latter, while making IndexBuilder much simpler by removing its dual purpose.
  • The separation of code between toolkit.util.IndexBuilder and formats.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 base IndexBuilder 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 in HtmlIndexBuilder are actually essential for our us.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8315464: Uncouple AllClassesIndexWriter from IndexBuilder (Task - P4)

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

@bridgekeeper
Copy link

bridgekeeper bot commented Sep 14, 2023

👋 Welcome back hannesw! 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 Sep 14, 2023
@openjdk
Copy link

openjdk bot commented Sep 14, 2023

@hns 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 Sep 14, 2023
@mlbridge
Copy link

mlbridge bot commented Sep 14, 2023

Webrevs

…mats/html/AllClassesIndexWriter.java


Remove whitespace

Co-authored-by: Andrey Turbanov <turbanoff@gmail.com>
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.

Approved.

I assume all tests pass, and that JDK API docs are not affected.

@openjdk
Copy link

openjdk bot commented Sep 22, 2023

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

8315464: Uncouple AllClassesIndexWriter from IndexBuilder

Reviewed-by: jjg

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 master branch:

  • 53516ae: 8304956: Update KeyStore.getDefaultType​() specification to return pkcs12 as fallback
  • 373cdf2: 8315960: test/jdk/java/io/File/TempDirDoesNotExist.java leaves test files behind
  • f7578e8: 8316540: StoreReproducibilityTest fails on some locales
  • b66ded9: 8316688: Widen allowable error bound of Math.hypot
  • 6c61bc1: 8316514: Better diagnostic header for VtableStub
  • c90d631: 8315750: Update subtype check profile collection on PPC following 8308869
  • 00f585b: 8316206: Test StretchedFontTest.java fails for Baekmuk font
  • c24c66d: 8316681: Rewrite URLEncoder.encode to use small reusable buffers
  • bd2439f: 8316702: Only evaluate buffer when IGVPrintLevelOption >= 5
  • 4b65483: 8316130: Incorrect control in LibraryCallKit::inline_native_notify_jvmti_funcs
  • ... and 152 more: https://git.openjdk.org/jdk/compare/b3dad2443a7cb239fda0a320b8790fab592c2eca...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.

➡️ 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 Sep 22, 2023
@hns
Copy link
Member Author

hns commented Sep 22, 2023

Thanks for reviewing!

I assume all tests pass, and that JDK API docs are not affected.

Yes to both.

@hns
Copy link
Member Author

hns commented Sep 22, 2023

/integrate

@openjdk
Copy link

openjdk bot commented Sep 22, 2023

Going to push as commit 6b8261b.
Since your change was applied there have been 163 commits pushed to the master branch:

  • 9b65b7d: 8316305: Initial buffer size of StackWalker is too small caused by JDK-8285447
  • 53516ae: 8304956: Update KeyStore.getDefaultType​() specification to return pkcs12 as fallback
  • 373cdf2: 8315960: test/jdk/java/io/File/TempDirDoesNotExist.java leaves test files behind
  • f7578e8: 8316540: StoreReproducibilityTest fails on some locales
  • b66ded9: 8316688: Widen allowable error bound of Math.hypot
  • 6c61bc1: 8316514: Better diagnostic header for VtableStub
  • c90d631: 8315750: Update subtype check profile collection on PPC following 8308869
  • 00f585b: 8316206: Test StretchedFontTest.java fails for Baekmuk font
  • c24c66d: 8316681: Rewrite URLEncoder.encode to use small reusable buffers
  • bd2439f: 8316702: Only evaluate buffer when IGVPrintLevelOption >= 5
  • ... and 153 more: https://git.openjdk.org/jdk/compare/b3dad2443a7cb239fda0a320b8790fab592c2eca...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Sep 22, 2023
@openjdk openjdk bot closed this Sep 22, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 22, 2023
@openjdk
Copy link

openjdk bot commented Sep 22, 2023

@hns Pushed as commit 6b8261b.

💡 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
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Development

Successfully merging this pull request may close these issues.

3 participants