Skip to content

Conversation

@dansmithcode
Copy link

@dansmithcode dansmithcode commented Nov 8, 2025

Updated the JSpec taglets to use relative links into ../specs/jls and ../specs/jvms rather than external links, possible now due to JDK-8370153.

I was surprised there doesn't seem to be a standard way to get a relative path to the docs root, but I copy/pasted from ToolGuide, and made some tweaks based on failures I saw.

Tested with 'make docs' and manually confirmed that a handful of different @jls and @jvms tags are pointing to the right place.


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-8370154: Update @jls and @jvms taglets to point to local specs dir (Enhancement - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28207

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 8, 2025

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

openjdk bot commented Nov 8, 2025

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

8370154: Update @jls and @jvms taglets to point to local specs dir

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

  • 88c4678: 8371103: vmTestbase/nsk/jvmti/scenarios/events/EM02/em02t006/TestDescription.java failing
  • 066810c: 8371485: ProblemList awt/Mixing/AWT_Mixing/JTableInGlassPaneOverlapping.java for linux

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

openjdk bot commented Nov 8, 2025

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

@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 8, 2025
@mlbridge
Copy link

mlbridge bot commented Nov 8, 2025

Webrevs

@liach
Copy link
Member

liach commented Nov 8, 2025

Looks goood. Meanwhile, do you think we should retain external link support via a system property? For the Java SE API specification only distribution for JCP, we might want to link to a static link instead of a local relative link. (I think as long as we can link, a relative link like here is better because it will be stable in the specdiff for JCP review, avoiding spams)

Since we removed the system property jspec.version, we should be able to remove this from the build files too:

-Djspec.version=$$(VERSION_SPECIFICATION)

@dansmithcode
Copy link
Author

JCP reviews actually happen before GA, so I think the external links are always dead anyway?

If it's something the JCP folks care about, I think the right solution is to include JLS & JVMS in the SE-only docs. (They are, after all, specs for Java SE.) But for now, I think the business as usual process is fine.

@dansmithcode
Copy link
Author

I'll confirm there are no more uses of jspec.version and update Docs.gmk.

@liach
Copy link
Member

liach commented Nov 8, 2025

I think we can go ahead with this once we verify Oracle's doc build passes. I will approve once the system property passing in Docs.gmk is updated.

@liach
Copy link
Member

liach commented Nov 8, 2025

I tested this patch on my local Linux-targeting OpenJDK WSL (because only Linux is building docs); the JVMS links become dead links in OpenJDK builds, which don't have access to JLS/JVMS, which are proprietary to Oracle. We should probably leave a comment that the dead links are intentional.

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.

Verified this passes on Oracle's CI.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build [email protected] javadoc [email protected] ready Pull request is ready to be integrated rfr Pull request is ready for review

Development

Successfully merging this pull request may close these issues.

2 participants