8332545: Fix handling of HTML5 entities in Markdown comments

[jonathan-gibbons]

Please review a small fix to address a crash when handling HTML5 entities in a Markdown doc comment.

The path for the entities.txt (originally entities.properties) was not correctly imported when importing the latest version of commonmark-java. And, the makefiles need to be updated to include the .txt file in the image. (The interim module for the interim javadoc already had this fix.)

A simple new test is provided, containing entities that previously caused javadoc to crash.

---

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-8332545: Fix handling of HTML5 entities in Markdown comments (Bug - P2)

Reviewers

• Pavel Rappo (@pavelrappo - Reviewer)
• Erik Joelsson (@erikj79 - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 19317

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back jjg! 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]

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

8332545: Fix handling of HTML5 entities in Markdown comments

Reviewed-by: prappo, erikj

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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]

@jonathan-gibbons The following labels will be automatically applied to this pull request:

• build
• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 00: Full (d534f01b)

[pavelrappo]

Assuming the test fails without the fix, but passes with it, looks good.

[jonathan-gibbons]

Assuming the test fails without the fix, but passes with it, looks good.

Confirmed the test fails without the fix (crash, as reported) and passes with the fix.

[erikj79]

Build change looks good.

[jonathan-gibbons]

Build change looks good.

Thank you

[jonathan-gibbons]

/integrate

[openjdk]

Going to push as commit 6e80512.

[openjdk]

@jonathan-gibbons Pushed as commit 6e80512.

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