JDK-8271258: @param with non-ascii variable names produces incorrect results #5168

jonathan-gibbons · 2021-08-18T20:10:48Z

Please review a simple change to fix the use of non-ASCII characters in @param names.

The underlying problem was accidentally relying on DocTree.toString() for an IdentifierTree in CommentHelper. The fix is simply to get the underlying Name and call toString on that.

There is some loosely related cleanup in ParamTaglet. I did see if it was possible to avoid excessive use of String in this part of the code, but that quickly became a rat-hole.

The existing related test is updated to include this new case, of a Chinese identifier occurring in various places, similar to the test case in the original bug.

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8271258: @param with non-ascii variable names produces incorrect results

Reviewers

Hannes Wallnöfer (@hns - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/5168/head:pull/5168
$ git checkout pull/5168

Update a local copy of the PR:
$ git checkout pull/5168
$ git pull https://git.openjdk.java.net/jdk pull/5168/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5168

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/5168.diff

…results

bridgekeeper · 2021-08-18T20:11:37Z

👋 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 · 2021-08-18T20:13:34Z

@jonathan-gibbons 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 · 2021-08-18T20:17:38Z

Webrevs

01: Full - Incremental (fc264885)
00: Full (de5e26ef)

hns

The fix and the added test look good, but I think you accidentally dropped a test string in the existing test.

hns · 2021-08-19T09:35:11Z

test/langtools/jdk/javadoc/doclet/testUnicode/TestUnicode.java

                "-encoding", "utf-8",
                src.resolve("Code.java").toString());
        checkExit(Exit.OK);

        checkOutput("Code.html", true,
-                "<div class=\"block\">Hel" + ellipsis + "lo <code>World(" + ellipsis + ")</code>.</div>");
+                """
+                        """);


Is don't think this is supposed to be an empty string, is it?

Oops, will investigate what happened in my repo.

This could've been detected during testing, if we had #4811.

hns

Looks good now!

openjdk · 2021-08-24T08:13:51Z

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

8271258: @param with non-ascii variable names produces incorrect results

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

22ef4f0: 5015261: NPE may be thrown if JDesktopIcon is set to null on a JInternalFrame
9bc0232: 8269223: -Xcheck:jni WARNINGs working with fonts on Linux
2ff4c01: 8271600: C2: CheckCastPP which should closely follow Allocate is sunk of a loop
ad92033: 8272736: [JVMCI] Add API for reading and writing JVMCI thread locals
709b591: 8272553: several hotspot runtime/CommandLine tests don't check exit code
1884072: 8265253: javac -Xdoclint:all gives "no comment" warning for code that can't be commented
594e516: 8272778: Consolidate is_instance and is_instance_inlined in java_lang_String
d542745: 8267894: Skip work for empty regions in G1 Full GC
741f58c: 8272417: ZGC: fastdebug build crashes when printing ClassLoaderData
b7f75c0: 8271142: package help is not displayed for missing X11/extensions/Xrandr.h
... and 27 more: https://git.openjdk.java.net/jdk/compare/96107e31dfe115fc102fa54d7bdd523c8a79ff76...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 · 2021-08-24T14:40:06Z

/integrate

openjdk · 2021-08-24T14:41:33Z

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

7454306: 8272526: Cleanup ThreadStateTransition class
0597cde: 8221360: Eliminate Shared_DirtyCardQ_lock
928b972: 8271930: Simplify end_card calculation in G1BlockOffsetTablePart::verify
7f80683: 8272783: Epsilon: Refactor tests to improve performance
22ef4f0: 5015261: NPE may be thrown if JDesktopIcon is set to null on a JInternalFrame
9bc0232: 8269223: -Xcheck:jni WARNINGs working with fonts on Linux
2ff4c01: 8271600: C2: CheckCastPP which should closely follow Allocate is sunk of a loop
ad92033: 8272736: [JVMCI] Add API for reading and writing JVMCI thread locals
709b591: 8272553: several hotspot runtime/CommandLine tests don't check exit code
1884072: 8265253: javac -Xdoclint:all gives "no comment" warning for code that can't be commented
... and 31 more: https://git.openjdk.java.net/jdk/compare/96107e31dfe115fc102fa54d7bdd523c8a79ff76...master

Your commit was automatically rebased without conflicts.

openjdk · 2021-08-24T14:41:47Z

@jonathan-gibbons Pushed as commit 94f5e44.

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

JDK-8271258: @param with non-ascii variable names produces incorrect …

de5e26e

…results

openjdk bot added the rfr Pull request is ready for review label Aug 18, 2021

openjdk bot added the javadoc javadoc-dev@openjdk.org label Aug 18, 2021

hns suggested changes Aug 19, 2021

View reviewed changes

repair broken test.

fc26488

hns approved these changes Aug 24, 2021

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Aug 24, 2021

openjdk bot closed this Aug 24, 2021

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Aug 24, 2021

jonathan-gibbons deleted the 8271258.param branch November 18, 2022 19:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

JDK-8271258: @param with non-ascii variable names produces incorrect results #5168

JDK-8271258: @param with non-ascii variable names produces incorrect results #5168

Uh oh!

jonathan-gibbons commented Aug 18, 2021 •

edited by openjdk bot

Loading

Uh oh!

bridgekeeper bot commented Aug 18, 2021

Uh oh!

openjdk bot commented Aug 18, 2021

Uh oh!

mlbridge bot commented Aug 18, 2021 •

edited

Loading

Uh oh!

hns left a comment

Uh oh!

hns Aug 19, 2021

Uh oh!

jonathan-gibbons Aug 23, 2021

Uh oh!

pavelrappo Aug 24, 2021

Uh oh!

hns left a comment

Uh oh!

openjdk bot commented Aug 24, 2021

Uh oh!

jonathan-gibbons commented Aug 24, 2021

Uh oh!

openjdk bot commented Aug 24, 2021

Uh oh!

openjdk bot commented Aug 24, 2021

Uh oh!

Uh oh!

JDK-8271258: @param with non-ascii variable names produces incorrect results #5168

JDK-8271258: @param with non-ascii variable names produces incorrect results #5168

Uh oh!

Conversation

jonathan-gibbons commented Aug 18, 2021 • 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 Aug 18, 2021

Uh oh!

openjdk bot commented Aug 18, 2021

Uh oh!

mlbridge bot commented Aug 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

hns left a comment

Choose a reason for hiding this comment

Uh oh!

hns Aug 19, 2021

Choose a reason for hiding this comment

Uh oh!

jonathan-gibbons Aug 23, 2021

Choose a reason for hiding this comment

Uh oh!

pavelrappo Aug 24, 2021

Choose a reason for hiding this comment

Uh oh!

hns left a comment

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Aug 24, 2021

Uh oh!

jonathan-gibbons commented Aug 24, 2021

Uh oh!

openjdk bot commented Aug 24, 2021

Uh oh!

openjdk bot commented Aug 24, 2021

Uh oh!

Uh oh!

jonathan-gibbons commented Aug 18, 2021 •

edited by openjdk bot

Loading

mlbridge bot commented Aug 18, 2021 •

edited

Loading