8281944: JavaDoc throws java.lang.IllegalStateException: ERRONEOUS

[shipilev]

Fixes a javadoc crash on incorrect @see. We have seen instances of this in our development pipelines.

Unfortunately, javadoc code changed considerably in modern releases. The original patch, while simple, does not apply well to javadoc from JDK 17. The backports of javadoc improvements that would make this clean to JDK 17 are hairy. So instead I amended the patch to work on JDK 17, see 9249ee4.

Additional testing:

• New test fails without the patch, passes with it
• MacOS AArch64 server fastdebug, jdk/javadoc pass

---

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
• JDK-8281944 needs maintainer approval

Issue

• JDK-8281944: JavaDoc throws java.lang.IllegalStateException: ERRONEOUS (Bug - P3 - Approved)

Reviewers

• Jonathan Gibbons (@jonathan-gibbons - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk17u-dev.git pull/2546/head:pull/2546
$ git checkout pull/2546

Update a local copy of the PR:
$ git checkout pull/2546
$ git pull https://git.openjdk.org/jdk17u-dev.git pull/2546/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 2546

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk17u-dev/pull/2546.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

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

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

8281944: JavaDoc throws java.lang.IllegalStateException: ERRONEOUS

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

• ce19e61: 8333724: Problem list security/infra/java/security/cert/CertPathValidator/certification/CAInterop.java#teliasonerarootcav1
• af699ff: 8325567: jspawnhelper without args fails with segfault
• a86a221: 8329995: Restricted access to /proc can cause JFR initialization to crash
• 28aa19e: 8316328: Test jdk/jfr/event/oldobject/TestSanityDefault.java times out for some heap sizes
• 9aa7b2f: 8279337: The MToolkit is still referenced in a few places
• 2db1501: 8323801: tag doesn't strikethrough the text
• 5377458: 8005885: enhance PrintCodeCache to print more data
• d23f4d6: 8282526: Default icon is not painted properly

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]

This backport pull request has now been updated with issue from the original commit.

[mlbridge]

Webrevs

• 00: Full (9249ee40)

[shipilev]

@pavelrappo, @jonathan-gibbons -- do you want to take a look at this?

[openjdk]

⚠️ @shipilev This change is now ready for you to apply for maintainer approval. This can be done directly in each associated issue or by using the /approval command.

[shipilev]

/approval request Fixes a javadoc crash on incorrect "see" tag. Seen failures in real-world. Requires adaptations for JDK 17, acked by Jonathan Gibbons. Javadoc tests pass. Risk is on lower side: only affects javadoc tool, and only on the path where it would otherwise crash.

[openjdk]

@shipilev
8281944: The approval request has been created successfully.

[shipilev]

Thank you for review, @jonathan-gibbons!

/integrate

[openjdk]

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

• bcd19a5: 8333698: [17u] TestJstatdRmiPort fails after JDK-8333667
• 2d9b1a6: 8303942: os::write should write completely
• 17d65fe: 8305072: Win32ShellFolder2.compareTo is inconsistent
• ffa8a10: 8292948: JEditorPane ignores font-size styles in external linked css-file
• 541a284: 8322726: C2: Unloaded signature class kills argument value
• 43a6746: 8307091: A few client tests intermittently throw ConcurrentModificationException
• ce19e61: 8333724: Problem list security/infra/java/security/cert/CertPathValidator/certification/CAInterop.java#teliasonerarootcav1
• af699ff: 8325567: jspawnhelper without args fails with segfault
• a86a221: 8329995: Restricted access to /proc can cause JFR initialization to crash
• 28aa19e: 8316328: Test jdk/jfr/event/oldobject/TestSanityDefault.java times out for some heap sizes
• ... and 4 more: https://git.openjdk.org/jdk17u-dev/compare/d117806dd0f4a651ac3264f81b8cf8d98db89b98...master

Your commit was automatically rebased without conflicts.

[openjdk]

@shipilev Pushed as commit bc857cb.

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