8373922: Enhance Taglet API to support relative URLs

[hns]

Please review an enhancement that adds a new default toString method to the jdk.javadoc.doclet.Taglet interface which receives the path to the documentation root directory as additional argument of type java.net.URI. (The initial version of this PR used java.nio.file.Path which was of course a blunder as that class uses a platform-dependent separator.)

This makes it possible to create correct relative URLs when a tag is rendered outside of its element's resource (such as in a summary page), which was previously impossible using the public Taglet API. It also makes it easier to build relative URLs in the common case where a tag is rendered in its element's normal location.

I also added the changes for JDK-8379520 to make use of the new API in JDK build Taglets to this PR. The changes to the JSpec and ToolGuide taglets consist in undoing the changes from JDK-8373909 and replacing it with the new functionality.

For SealedGraph it's a bit more involved, because in order to be able to use the pathToRoot URI I had to change the naming of .svg files for nested classes to not use subdirectories for enclosing classes so that these files use the same directory as all the other files from that package.

---

• I confirm that I make this contribution in accordance with the OpenJDK Interim AI Policy.

---

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
• Change requires CSR request JDK-8375025 to be approved

Issues

• JDK-8373922: Enhance Taglet API to support relative URLs (Enhancement - P4)
• JDK-8379520: Make use of new Taglet.toString method in JDK build taglets (Task - P4)
• JDK-8375025: Enhance Taglet API to support relative URLs (CSR)

Reviewers

• Chen Liang (@liach - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 30120

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 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]

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

8373922: Enhance Taglet API to support relative URLs
8379520: Make use of new Taglet.toString method in JDK build taglets

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

• 26df25e: 8382045: Increase AOT C strings table size in not product VM
• 04bb3a9: 8381176: Utilities.expectedNegoAppProtocol chooses client ALPN protocol over server's
• 8688c0b: 8379129: C2 crash in LoadNode::can_split_through_phi_base during Escape Analysis (JDK 25.0.1+8)
• ... and 9 more: https://git.openjdk.org/jdk/compare/21213024501cb3f19b2c42bd56f5553807dace9b...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]

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

[mlbridge]

Webrevs

• 04: Full (fa45c496)
• 03: Full - Incremental (9eed0aa3)
• 02: Full - Incremental (ab2df77b)
• 01: Full - Incremental (317ee81d)
• 00: Full (112475ed)

[liach]

Can we remove the hack used by JSpec taglet as a POC of this new API? Or do you plan to do in a later RFE?

[hns]

@liach I've filed a separate issue JDK-8379520 for the Taglet cleanup, but I'm adding the changes to this PR as I think it's good to see the new API in use. I can move it to a separate PR if necessary.

[hns]

/issue add JDK-8379520

[openjdk]

@hns
Adding additional issue to issue list: 8379520: Make use of new Taglet.toString method in JDK build taglets.

[openjdk]

@hns build has been added to this pull request based on files touched in new commit(s).

[liach]

Great!

[bridgekeeper]

@hns This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply issue a /touch or /keepalive command to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

[openjdk]

@hns this pull request can not be integrated into master due to one or more merge conflicts. To resolve these merge conflicts and update this pull request you can run the following commands in the local repository for your personal fork:

git checkout JDK-8373922
git fetch https://git.openjdk.org/jdk.git master
git merge FETCH_HEAD
# resolve conflicts and follow the instructions given by git merge
git commit -m "Merge master"
git push

[hns]

/template append

[openjdk]

@hns The pull request template has been appended to the pull request body

[hns]

@liach could you please re-approve this PR?
The changes since your first review are changes to the doc comment due to CSR review, and merging of your changes to SealedGraph taglet.

[hns]

Thanks!

/integrate

[openjdk]

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

• 91cde7f: 8382327: Disable some SA tests for mixed jstack on musl C
• 26df25e: 8382045: Increase AOT C strings table size in not product VM
• 04bb3a9: 8381176: Utilities.expectedNegoAppProtocol chooses client ALPN protocol over server's
• ... and 10 more: https://git.openjdk.org/jdk/compare/21213024501cb3f19b2c42bd56f5553807dace9b...master

Your commit was automatically rebased without conflicts.

[openjdk]

@hns Pushed as commit 35ad47b.

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