JDK-8305593: Add @spec tags in java.desktop #13360

jonathan-gibbons · 2023-04-05T17:29:17Z

Please review a docs-only change to add @spec tags into java.desktop public API files

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-8305593: Add @SPEC tags in java.desktop (Enhancement - "3")

Reviewers

Phil Race (@prrace - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13360

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2023-04-05T17:30:54Z

👋 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 · 2023-04-05T17:33:49Z

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

client

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 · 2023-04-05T17:38:11Z

Webrevs

01: Full - Incremental (fcccc85f)
00: Full (374a088c)

prrace · 2023-04-07T01:35:58Z

src/java.desktop/share/classes/java/awt/Desktop.java

@@ -587,6 +587,8 @@ public void mail() throws IOException {
     * {@code AWTPermission("showWindowWithoutWarningBanner")}
     * permission, or the calling thread is not allowed to create a
     * subprocess
+     * @spec https://www.rfc-editor.org/info/rfc2368
+     *      RFC 2368: The mailto URL scheme


The javadoc above references ietf.org. This tag references rfc-editor.org. It seems odd to use two different URLs
in the same method specification for the same RFC. I would have thought the ietf one better to use .. although it should be updated to https

This work is primarily about adding @spec tags, in a semi-automated fashion, using a custom utility that scans comments in the public API, looking for hrefs to "well-known" sites hosting external specifications. While "mostly automated", I did manually cleanup the references by line-wrapping as appropriate.

It is out of scope at this time to cleanup up the underlying hrefs, although we should look at cleaning up those links later, identifying the latest/preferred URL for the appropriate version of the spec document, which may or may not be the latest overall version of the spec. (For example, the client docs reference HTML 3.2, and should not reference anything more recent.). This cleanup can be done later and needs to be done in conjunction with the relevant teams, and probably not as a semi-automated update. Such cleanup should be somewhat easier once we have tagged the affected comments with the relevant @spec tags.

I note that once we have completed the addition of the @spec tags, we will, re-enable the new "External Specifications" page, which cross-references where each individual external specification is mentioned in the overall API documentation.

Sorry, but no matter how many times I try, it seems wrong to even for some short amount of time to have @SPEC point to one place and the javadoc point to another. They should always be consistent.
If it is out of scope to update the javadoc, then the new spec tag should just match the existing javadoc.

For the rfc-editor.org that's going to be hard, insofar as there are strong opinions (voiced in an earlier round of review) about using references to the old sites.

I see just 18 references matching href=....ietf.org so I guess I can manually update those for you.

$ grep -r 'href=[^ ]*ietf.org' open/src/java.desktop open/src/java.desktop/share/classes/sun/awt/image/PNGImageDecoder.java: See <a href=http://www.ietf.org/rfc/rfc2083.txt>RFC2083</a> for details. */ open/src/java.desktop/share/classes/java/awt/Desktop.java: * href="http://www.ietf.org/rfc/rfc2368.txt">The mailto URL open/src/java.desktop/share/classes/java/awt/peer/DesktopPeer.java: * <a href="http://www.ietf.org/rfc/rfc2368.txt">RFC2368: The mailto open/src/java.desktop/share/classes/javax/print/attribute/standard/Compression.java: * <a href="http://www.ietf.org/rfc/rfc1952.txt">RFC 1952</a>. open/src/java.desktop/share/classes/javax/print/attribute/standard/MediaSizeName.java: * <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911</a> open/src/java.desktop/share/classes/javax/print/attribute/standard/Fidelity.java: * <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911</a> Section 15.1 for a open/src/java.desktop/share/classes/javax/print/attribute/standard/package-info.java: * <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911</a> for more open/src/java.desktop/share/classes/javax/print/DocFlavor.java: * <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a> and open/src/java.desktop/share/classes/javax/print/DocFlavor.java: * <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>) that specifies open/src/java.desktop/share/classes/javax/print/DocFlavor.java: * <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>, which says the open/src/java.desktop/share/classes/javax/print/DocFlavor.java: * <a href="http://www.ietf.org/rfc/rfc2278.txt"> open/src/java.desktop/share/classes/javax/print/package-info.java: * <a href="http://www.ietf.org/rfc/rfc2911.txt">RFC 2911 Internet Printing open/src/java.desktop/share/classes/javax/print/MimeType.java: * <a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a> and open/src/java.desktop/share/classes/javax/print/MimeType.java: * <a href="http://www.ietf.org/rfc/rfc2046.txt">RFC 2046</a>. A MIME type open/src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java: * @see <a href="https://tools.ietf.org/html/rfc1951">DEFLATE specification</a> open/src/java.desktop/share/classes/javax/imageio/plugins/tiff/FaxTIFFTagSet.java: * <a href="https://tools.ietf.org/html/rfc2306.html">TIFF-F</a> (RFC 2036) file. open/src/java.desktop/share/classes/javax/imageio/metadata/doc-files/tiff_metadata.html:<td><a href="https://tools.ietf.org/html/rfc1950"> open/src/java.desktop/share/classes/javax/imageio/metadata/doc-files/tiff_metadata.html:<a href="https://tools.ietf.org/html/rfc1951"> $ grep -r 'href=[^ ]*ietf.org' open/src/java.desktop | wc -l 18

prrace · 2023-04-07T01:36:37Z

src/java.desktop/share/classes/javax/imageio/plugins/tiff/BaselineTIFFTagSet.java

@@ -222,7 +222,8 @@ public final class BaselineTIFFTagSet extends TIFFTagSet {
     * A value to be used with the "Compression" tag.
     *
     * @see #TAG_COMPRESSION
-     * @see <a href="https://tools.ietf.org/html/rfc1951">DEFLATE specification</a>
+     * @spec https://www.rfc-editor.org/info/rfc1951
+     *      RFC 1951: DEFLATE Compressed Data Format Specification version 1.3
     */


OK. So why are you preferring this rfc-editor.org site ?
Seems we should get that cleared up before I look further

Because we were strongly recommended to do so, in an earlier round of review.

I have no idea who that person is with the strong opinions, and hence no idea of his standing to assert the opinion.
So I'd be reluctant to follow his suggestion without more info.
But they still should be the same.

jonathan-gibbons · 2023-04-11T20:02:08Z

On the use of rfc-editor.org, this site came up during the original all-in-one version of this work in PR #11073.
See, for example, these messages:

So, despite being a non-obvious host name, it seems like this is the preferred long-term place for references to RFCs.

…ava.desktop

…nts of) `ietf.org`

prrace

All LGTM.

openjdk · 2023-06-05T17:48:48Z

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

8305593: Add @spec tags in java.desktop

Reviewed-by: prr

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

33bb64f: 8309614: [BACKOUT] JDK-8307153 JVMTI GetThreadState on carrier should return STATE_WAITING
5b147eb: 8308288: Fix xlc17 clang warnings and build errors in hotspot
89f5bac: 8309225: Fix xlc17 clang 15 warnings in security and servicability
6eddbe2: 8309219: Fix xlc17 clang 15 warnings in java.base
177e832: 8307153: JVMTI GetThreadState on carrier should return STATE_WAITING
f0236ed: 8309543: Micro-optimize x86 assembler UseCondCardMark
9d7bf53: 8280982: [Wayland] [XWayland] java.awt.Robot taking screenshots
a1ab377: 8309550: jdk.jfr.internal.Utils::formatDataAmount method should gracefully handle amounts equal to Long.MIN_VALUE
c49129f: 8308445: Linker should check that capture state segment is big enough
fa79111: 8308031: Linkers should reject unpromoted variadic parameters
... and 110 more: https://git.openjdk.org/jdk/compare/eae1f59da966f68c8e11547aec123741c1d21fef...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.

jonathan-gibbons · 2023-06-08T18:59:32Z

/integrate

openjdk · 2023-06-08T19:00:22Z

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

0be3905: 8309595: Allow javadoc to process unnamed classes
b2a5271: 8309196: Remove Thread.countStackFrames
bb96682: 8309498: [JVMCI] race in CallSiteTargetValue recording
5a706fb: 8306584: Start of release updates for JDK 22
bb377b2: 8306841: Generational ZGC: NMT reports Java heap size larger than max heap size
ac3ce2b: 8304425: ClassHierarchyResolver from Reflection
79a4ac7: 8309235: Unnamed Variables (_) can't be used in JShell
9d64a9d: 8306431: File.listRoots method description should be re-examined
5af9d2a: 8309602: update JVMTI history table for jdk 21
6646272: 8308764: Reporting errors from create_vm may crash
... and 134 more: https://git.openjdk.org/jdk/compare/eae1f59da966f68c8e11547aec123741c1d21fef...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-06-08T19:00:29Z

@jonathan-gibbons Pushed as commit 34f0a6e.

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

JDK-8305593: Add @SPEC tags in java.desktop

374a088

openjdk bot added the rfr Pull request is ready for review label Apr 5, 2023

openjdk bot added the client client-libs-dev@openjdk.org label Apr 5, 2023

prrace reviewed Apr 7, 2023

View reviewed changes

jonathan-gibbons added 2 commits May 31, 2023 11:43

Merge remote-tracking branch 'upstream/master' into 8305593.at-spec-j…

abe6fa1

…ava.desktop

Update narrative references to use rfc-editor.org instead of (varia…

fcccc85

…nts of) `ietf.org`

prrace approved these changes Jun 5, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jun 5, 2023

openjdk bot added the integrated Pull request has been integrated label Jun 8, 2023

openjdk bot closed this Jun 8, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jun 8, 2023

jonathan-gibbons deleted the 8305593.at-spec-java.desktop branch June 8, 2023 19:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JDK-8305593: Add @spec tags in java.desktop #13360

JDK-8305593: Add @spec tags in java.desktop #13360

jonathan-gibbons commented Apr 5, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Apr 5, 2023

openjdk bot commented Apr 5, 2023

mlbridge bot commented Apr 5, 2023 •

edited

Loading

prrace Apr 7, 2023

jonathan-gibbons Apr 11, 2023 •

edited

Loading

prrace May 3, 2023

jonathan-gibbons May 5, 2023

jonathan-gibbons May 5, 2023

prrace Apr 7, 2023

jonathan-gibbons May 5, 2023

prrace May 5, 2023

jonathan-gibbons commented Apr 11, 2023 •

edited

Loading

prrace left a comment

openjdk bot commented Jun 5, 2023 •

edited

Loading

jonathan-gibbons commented Jun 8, 2023

openjdk bot commented Jun 8, 2023

openjdk bot commented Jun 8, 2023

JDK-8305593: Add @spec tags in java.desktop #13360

JDK-8305593: Add @spec tags in java.desktop #13360

Conversation

jonathan-gibbons commented Apr 5, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Apr 5, 2023

openjdk bot commented Apr 5, 2023

mlbridge bot commented Apr 5, 2023 • edited Loading

Webrevs

prrace Apr 7, 2023

Choose a reason for hiding this comment

jonathan-gibbons Apr 11, 2023 • edited Loading

Choose a reason for hiding this comment

prrace May 3, 2023

Choose a reason for hiding this comment

jonathan-gibbons May 5, 2023

Choose a reason for hiding this comment

jonathan-gibbons May 5, 2023

Choose a reason for hiding this comment

prrace Apr 7, 2023

Choose a reason for hiding this comment

jonathan-gibbons May 5, 2023

Choose a reason for hiding this comment

prrace May 5, 2023

Choose a reason for hiding this comment

jonathan-gibbons commented Apr 11, 2023 • edited Loading

prrace left a comment

Choose a reason for hiding this comment

openjdk bot commented Jun 5, 2023 • edited Loading

jonathan-gibbons commented Jun 8, 2023

openjdk bot commented Jun 8, 2023

openjdk bot commented Jun 8, 2023

jonathan-gibbons commented Apr 5, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Apr 5, 2023 •

edited

Loading

jonathan-gibbons Apr 11, 2023 •

edited

Loading

jonathan-gibbons commented Apr 11, 2023 •

edited

Loading

openjdk bot commented Jun 5, 2023 •

edited

Loading