Skip to content

Conversation

@hns
Copy link
Member

@hns hns commented May 6, 2025

Please review a simple fix to avoid a JavaScript error in API docs when syntax highlighting is not enabled.

The fix consists in replacing (hljs) with (typeof hljs !== "undefined") in the if statement as the former throws a TypeError if hljs is undefined. The try-catch wrapper around hljs.highlightAll() is just added to be on the safe side, and the change in Head.java is just cleanup to preserve the separateion of .css and .js files.

Labeled noreg-hard as we do not have a way to test the script in browser. I manually tested the fix in multiple browsers.


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-8356276: JavaScript error in script.js after JDK-8348282 (Bug - P3)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25069

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented May 6, 2025

👋 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
Copy link

openjdk bot commented May 6, 2025

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

8356276: JavaScript error in script.js after JDK-8348282

Reviewed-by: liach

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 1 new commit pushed to the master branch:

  • 088825e: 8355979: ATTRIBUTE_NO_UBSAN needs to be extended to handle float divisions by zero on AIX

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 changed the title JDK-8356276: JavaScript error in script.js after JDK-8348282 8356276: JavaScript error in script.js after JDK-8348282 May 6, 2025
@openjdk openjdk bot added the rfr Pull request is ready for review label May 6, 2025
@openjdk
Copy link

openjdk bot commented May 6, 2025

@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 6, 2025
@mlbridge
Copy link

mlbridge bot commented May 6, 2025

Webrevs

Copy link
Member

@liach liach left a comment

Choose a reason for hiding this comment

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

The js part looks good. Is the Java code just trivial cleanup and doesn't affect correctness of this patch?

@openjdk openjdk bot added the ready Pull request is ready to be integrated label May 6, 2025
@hns
Copy link
Member Author

hns commented May 6, 2025

The js part looks good. Is the Java code just trivial cleanup and doesn't affect correctness of this patch?

Exactly, it's just to copy CSS and JS files each in their own method.
Thanks for the quick review!

@hns
Copy link
Member Author

hns commented May 6, 2025

/integrate

@openjdk
Copy link

openjdk bot commented May 6, 2025

Going to push as commit 9477c42.
Since your change was applied there has been 1 commit pushed to the master branch:

  • 088825e: 8355979: ATTRIBUTE_NO_UBSAN needs to be extended to handle float divisions by zero on AIX

Your commit was automatically rebased without conflicts.

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

openjdk bot commented May 6, 2025

@hns Pushed as commit 9477c42.

💡 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.

2 participants