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-8309471: Limit key characters in static index pages #14312

Closed
wants to merge 3 commits into from

Conversation

hns
Copy link
Member

@hns hns commented Jun 5, 2023

Please review a simple change to avoid adding section index items (added in JDK-8286470) from appearing in the static index pages where the tend to cause trouble.

The change is implemented by making IndexItem.isTagItem() behave true to its specification again and only return true if it actually represents a JavaDoc tag, and add a new IndexItem.isSectionItem() method for the new section index items. The new method is used to make sure section links are not listed in the index pages.


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-8309471: Limit key characters in static index pages (Bug - P3)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14312

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

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

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

mlbridge bot commented Jun 5, 2023

Webrevs

@jonathan-gibbons
Copy link
Contributor

jonathan-gibbons commented Jun 6, 2023

I think it is (still) a good default to be able to say that the static and interactive index have the same content.

I agree that headings that begin with a perceived section number are somewhat problematic. While it might be possible to detect/skip a leading dotted-number "word", I think a simpler algorithm to index under the first letter is simpler to explain and mostly good enough. (It would only be less than ideal if the first word is an alphanumeric sequence like 802.11az)

@openjdk
Copy link

openjdk bot commented Jun 7, 2023

@hns Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

@hns hns changed the title JDK-8309471: Do not list section links in static index pages JDK-8309471: Limit key characters in static index pages Jun 7, 2023
@hns
Copy link
Member Author

hns commented Jun 7, 2023

I updated the pull request to limit key characters to valid Java identifier start characters in the static index pages. The asterisk character * is used for index items that do not contain such a character. This is in line with the previous behaviour where asterisk was used for empty strings. The test was updated to contain some headings with ordinal numbers and to check the exact HTML for the index page.

@hns
Copy link
Member Author

hns commented Jun 7, 2023

Note that most items with leading non-java-identifier-start characters are now grouped at the beginning of each section. To avoid this, we'd have to tweak the Comparator used for these listings, which is out of scope for this change.

Screenshot 2023-06-07 at 12 56 00

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 solution

// or '*' for strings that do not contain one.
for (int i = 0; i < s.length(); i++) {
if (Character.isJavaIdentifierStart(s.charAt(i))) {
return Character.toUpperCase(s.charAt(i));
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe use the overload that takes a locale, and use Locale.ROOT

Copy link
Member Author

Choose a reason for hiding this comment

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

I just learned that Character.toUpperCase does not have a locale-sensitive overload, we'd have to use String.toUpperCase for that. I don't think it's that important in this case, so I'm leaving the code as it is.

@openjdk
Copy link

openjdk bot commented Jun 16, 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:

8309471: Limit key characters in static index pages

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

  • 44a8aa0: 8308609: java/lang/ScopedValue/StressStackOverflow.java fails with "-XX:-VMContinuations"
  • b412fc7: 8309937: Add @sealedGraph for some Panama FFM interfaces
  • fb024fd: 8248149: G1: change _cleaning_claimed from int to bool
  • c2b043e: 8310183: Update GitHub Actions to use boot JDK for building jtreg
  • 238c51e: 8293069: Make -XX:+Verbose less verbose
  • 8c9b85a: 8303916: ThreadLists.java inconsistent results
  • 227656f: 8309408: Thread.sleep cleanup
  • 32243ef: 8310128: Switch with unnamed patterns erroneously non-exhaustive
  • cfae6ef: 8309778: java/nio/file/Files/CopyAndMove.java fails when using second test directory
  • db133db: 8310106: sun.security.ssl.SSLHandshake.getHandshakeProducer() incorrectly checks handshakeConsumers
  • ... and 183 more: https://git.openjdk.org/jdk/compare/6d511f1376e3a0183a484443d05142678bdaa1c2...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 Jun 16, 2023
@hns
Copy link
Member Author

hns commented Jun 16, 2023

/integrate

@openjdk
Copy link

openjdk bot commented Jun 16, 2023

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

  • 44a8aa0: 8308609: java/lang/ScopedValue/StressStackOverflow.java fails with "-XX:-VMContinuations"
  • b412fc7: 8309937: Add @sealedGraph for some Panama FFM interfaces
  • fb024fd: 8248149: G1: change _cleaning_claimed from int to bool
  • c2b043e: 8310183: Update GitHub Actions to use boot JDK for building jtreg
  • 238c51e: 8293069: Make -XX:+Verbose less verbose
  • 8c9b85a: 8303916: ThreadLists.java inconsistent results
  • 227656f: 8309408: Thread.sleep cleanup
  • 32243ef: 8310128: Switch with unnamed patterns erroneously non-exhaustive
  • cfae6ef: 8309778: java/nio/file/Files/CopyAndMove.java fails when using second test directory
  • db133db: 8310106: sun.security.ssl.SSLHandshake.getHandshakeProducer() incorrectly checks handshakeConsumers
  • ... and 183 more: https://git.openjdk.org/jdk/compare/6d511f1376e3a0183a484443d05142678bdaa1c2...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Jun 16, 2023
@openjdk openjdk bot closed this Jun 16, 2023
@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Jun 16, 2023
@openjdk
Copy link

openjdk bot commented Jun 16, 2023

@hns Pushed as commit 21f6d83.

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

@openjdk openjdk bot removed the rfr Pull request is ready for review label Jun 16, 2023
@hns
Copy link
Member Author

hns commented Jun 19, 2023

/backport jdk21

@openjdk
Copy link

openjdk bot commented Jun 19, 2023

@hns the backport was successfully created on the branch hns-backport-21f6d833 in my personal fork of openjdk/jdk21. To create a pull request with this backport targeting openjdk/jdk21:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 21f6d833 from the openjdk/jdk repository.

The commit being backported was authored by Hannes Wallnöfer on 16 Jun 2023 and was reviewed by Jonathan Gibbons.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk21:

$ git fetch https://github.com/openjdk-bots/jdk21.git hns-backport-21f6d833:hns-backport-21f6d833
$ git checkout hns-backport-21f6d833
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk21.git hns-backport-21f6d833

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