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-8286470: Support searching for sections in class/package javadoc #14179

Closed
wants to merge 1 commit into from

Conversation

hns
Copy link
Member

@hns hns commented May 26, 2023

Please review a change to generate search index entries for all HTML headings in the documentation comments and auxiliary files. The change is relatively straightforward, new code replaces and complements the code to generate id attributes for all headings.

JDK API docs generated with this change are available here: https://cr.openjdk.org/~hannesw/8286470/api.00/


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-8286470: Support searching for sections in class/package javadoc

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/14179/head:pull/14179
$ git checkout pull/14179

Update a local copy of the PR:
$ git checkout pull/14179
$ git pull https://git.openjdk.org/jdk.git pull/14179/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14179

View PR using the GUI difftool:
$ git pr show -t 14179

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/14179.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented May 26, 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 May 26, 2023
@openjdk
Copy link

openjdk bot commented May 26, 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 May 26, 2023
@mlbridge
Copy link

mlbridge bot commented May 26, 2023

Webrevs

Comment on lines +1514 to +1516
HtmlId htmlId = htmlIds.forHeading(headingContent, headingIds);
id = htmlId.name();
attrs.add("id=\"").add(htmlId.name()).add("\"");
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not saying this is wrong, but it does look like a weird way to achieve the goal. It seems like either the wrong type is being passed in (Content instead of HtmlTree) or we're missing some abstraction here.

I guess it is the same methodology as before.

OK, I see it is input for a RawHtml node :-(

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.

Nice to see more uses of the index.

@openjdk
Copy link

openjdk bot commented May 26, 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:

8286470: Support searching for sections in class/package javadoc

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

  • ce5251a: 8308657: ReplayInline is not availabe in production build
  • cc0976b: 8308589: gc/cslocker/TestCSLocker.java timed out
  • 17ef8a4: 8299665: /proc/self/stat parsing in libmanagement broken by execname with spaces
  • c494770: 8306812: Open source several AWT Miscellaneous tests
  • d3b9b36: 8308009: Generational ZGC: OOM before clearing all SoftReferences
  • bac02b6: 8305189: C2 failed "assert(_outcnt==1) failed: not unique"

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 May 26, 2023
@hns
Copy link
Member Author

hns commented May 26, 2023

/integrate

@openjdk
Copy link

openjdk bot commented May 26, 2023

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

  • 55d297f: 8308594: Use atomic bitset function for PackageEntry::_defined_by_cds_in_class_path
  • c72b547: 8308801: update for deprecated sprintf for libnet in java.base
  • 77c5adb: 8308935: jdk.management.jfr.RecordingInfo.toString() lacks test coverage
  • ce5251a: 8308657: ReplayInline is not availabe in production build
  • cc0976b: 8308589: gc/cslocker/TestCSLocker.java timed out
  • 17ef8a4: 8299665: /proc/self/stat parsing in libmanagement broken by execname with spaces
  • c494770: 8306812: Open source several AWT Miscellaneous tests
  • d3b9b36: 8308009: Generational ZGC: OOM before clearing all SoftReferences
  • bac02b6: 8305189: C2 failed "assert(_outcnt==1) failed: not unique"

Your commit was automatically rebased without conflicts.

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

openjdk bot commented May 26, 2023

@hns Pushed as commit a923634.

💡 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
2 participants