8373909: JSpec and ToolGuide taglets use incorrect relative path by dansmithcode · Pull Request #28878 · openjdk/jdk

dansmithcode · 2025-12-17T20:09:44Z

Fixing the JSpec and ToolGuide taglets so that they produce correct links, no matter what file the tag appears in.

This is a workaround solution, sharing the necessary info via a ThreadLocal public static field in an internal API. See JDK-8373922 for an API enhancement request that would make this possible without relying on internal API.

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-8373909: JSpec and ToolGuide taglets use incorrect relative path (Bug - P3)(⚠️ The fixVersion in this issue is [26] but the fixVersion in .jcheck/conf is 27, a new backport will be created when this pr is integrated.)

Reviewers

Chen Liang (@liach - Reviewer)
Hannes Wallnöfer (@hns - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28878

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

Using diff file

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

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-12-17T20:11:09Z

👋 Welcome back dlsmith! 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 · 2025-12-17T20:12:49Z

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

8373909: JSpec and ToolGuide taglets use incorrect relative path

Reviewed-by: liach, hannesw

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

4f283f1: 8373820: C2: Robust Node::uncast_helper infinite loop check
d8eb125: 8373866: Refactor java/net/httpclient/ThrowingSubscribers*.java tests to use JUnit5
c6da35d: 8373796: Refactor java/net/httpclient/ThrowingPublishers*.java tests to use JUnit5
... and 14 more: https://git.openjdk.org/jdk/compare/f3a48560b5e3a280f6f76031eb3d475ff9ee49f4...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 · 2025-12-17T20:13:56Z

@dansmithcode 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.

dansmithcode · 2025-12-17T20:14:05Z

Planning to integrate this into 27 and create a backport to 26

dansmithcode · 2025-12-17T20:16:32Z

The relevant test is jdk/javadoc/doccheck/checks/jdkCheckLinks.java, which is currently problem-listed and will be turned back on via JDK-8370249. It fails before this fix, passes afterwards (when I take it off the problem list).

mlbridge · 2025-12-17T20:19:50Z

Webrevs

01: Full - Incremental (180eea30)
00: Full (1ad28fa3)

liach · 2025-12-17T22:19:44Z

make/jdk/src/classes/build/tools/taglet/JSpec.java

+    private String currentPath() {
+        try {
+            Class<?> c = Class.forName("jdk.javadoc.internal.doclets.formats.html.HtmlDocletWriter");
+            ThreadLocal<?> tl = (ThreadLocal<?>) c.getField("CURRENT_PATH").get(null);


I hope the performance overhead of repeated reflective lookup is acceptable... Ideally we should keep the Field in a static final variable.

Ok, fair point (although n is fairly small). Pushed an update that caches the ThreadLocal in a static field.

liach · 2025-12-17T22:21:50Z

I checked whether we can make the taglet compile against jdk.javadoc and use the field directly - don't think it's worth the make system hassle.

liach

Good

hns

Looks good.

dansmithcode · 2025-12-18T17:21:02Z

/integrate

dansmithcode · 2025-12-18T17:21:22Z

/backport :jdk26

openjdk · 2025-12-18T17:21:43Z

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

7a7e7c9: 8373877: QUIC connections are removed too early
b848ddf: 8373110: jstack --mixed frames are broken on macOS after JDK-8371194
3258e4d: 8373068: Revisit details of Float16 to decimal conversion algorithm
... and 20 more: https://git.openjdk.org/jdk/compare/f3a48560b5e3a280f6f76031eb3d475ff9ee49f4...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-12-18T17:21:50Z

@dansmithcode Pushed as commit 0b27124.

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

openjdk · 2025-12-18T17:22:43Z

@dansmithcode the backport was successfully created on the branch backport-dansmithcode-0b271240-jdk26 in my personal fork of openjdk/jdk. To create a pull request with this backport targeting openjdk/jdk:jdk26, 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 0b271240 from the openjdk/jdk repository.

The commit being backported was authored by Dan Smith on 18 Dec 2025 and was reviewed by Chen Liang and Hannes Wallnöfer.

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/jdk:

$ git fetch https://github.com/openjdk-bots/jdk.git backport-dansmithcode-0b271240-jdk26:backport-dansmithcode-0b271240-jdk26
$ git checkout backport-dansmithcode-0b271240-jdk26
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk.git backport-dansmithcode-0b271240-jdk26

Dan Smith added 6 commits December 11, 2025 10:49

Share current path with JSpec to get accurate links to root

c704c7b

use same convention in ToolGuide, tidying up

bd34a2d

Merge branch 'main' into 8373909

514b064

clarifying exceptions/comment

a44a994

Simplified command line

04879bf

restore test/docs/ProblemList.txt (to be fixed with different issue)

4f1a024

whitespace fixes

1ad28fa

openjdk bot added javadoc javadoc-dev@openjdk.org build build-dev@openjdk.org labels Dec 17, 2025

openjdk bot added the rfr Pull request is ready for review label Dec 17, 2025

liach approved these changes Dec 17, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Dec 17, 2025

Factor out reflection code to run just once

180eea3

openjdk bot removed the ready Pull request is ready to be integrated label Dec 18, 2025

liach approved these changes Dec 18, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Dec 18, 2025

hns approved these changes Dec 18, 2025

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Dec 18, 2025

openjdk bot closed this Dec 18, 2025

openjdk bot removed the ready Pull request is ready to be integrated label Dec 18, 2025

openjdk bot removed the rfr Pull request is ready for review label Dec 18, 2025

Conversation

dansmithcode commented Dec 17, 2025 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Dec 17, 2025

Uh oh!

openjdk bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dansmithcode commented Dec 17, 2025

Uh oh!

dansmithcode commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mlbridge bot commented Dec 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

liach Dec 17, 2025

Choose a reason for hiding this comment

Uh oh!

dansmithcode Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

liach commented Dec 17, 2025

Uh oh!

liach left a comment

Choose a reason for hiding this comment

Uh oh!

hns left a comment

Choose a reason for hiding this comment

Uh oh!

dansmithcode commented Dec 18, 2025

Uh oh!

dansmithcode commented Dec 18, 2025

Uh oh!

openjdk bot commented Dec 18, 2025

Uh oh!

openjdk bot commented Dec 18, 2025

Uh oh!

openjdk bot commented Dec 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

dansmithcode commented Dec 17, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Dec 17, 2025 •

edited

Loading

openjdk bot commented Dec 17, 2025 •

edited

Loading

dansmithcode commented Dec 17, 2025 •

edited

Loading

mlbridge bot commented Dec 17, 2025 •

edited

Loading