Skip to content

Conversation

@magicus
Copy link
Member

@magicus magicus commented Apr 17, 2025

As part of the UTF-8 cleaning up done in JDK-8301971, I looked at where and how we are using unicode sequences (\uXXXX). In several string literals, I think the unicode sequences still has merit, if they improve clarity or readability of the code. Some instances are more gray zone. But the places where it does not make sense at all are in comments, as part of fluid text comments. There they are just disruptive and not helpful at all. I tried to locate all such places (but I might have missed places, I did not do a proper lexical analysis to find comments) and fix them.

99% of this fix is to turn poor Peter von der Ah\u00e9 into Peter von der Ahé. 😆

I checked some random samples on when this was introduced to see if there were some particular commit that mistreated the encoding, but they have been there since the original release of the open JDK source code.

There are likely many more places where direct UTF-8 encoded characters is preferable to unicode sequences, but this seemed like a safe and trivial first start.


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-8354968: Replace unicode sequences in comment text with UTF-8 characters (Bug - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 24727

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 17, 2025

👋 Welcome back ihse! 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 Apr 17, 2025

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

8354968: Replace unicode sequences in comment text with UTF-8 characters

Reviewed-by: naoto

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 4 new commits pushed to 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 openjdk bot added the rfr Pull request is ready for review label Apr 17, 2025
@openjdk
Copy link

openjdk bot commented Apr 17, 2025

@magicus The following labels will be automatically applied to this pull request:

  • compiler
  • core-libs
  • i18n

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 core-libs core-libs-dev@openjdk.org compiler compiler-dev@openjdk.org i18n i18n-dev@openjdk.org labels Apr 17, 2025
@mlbridge
Copy link

mlbridge bot commented Apr 17, 2025

Webrevs

@magicus
Copy link
Member Author

magicus commented May 9, 2025

Now that JDK-8301971 is committed, this PR is ready to be integrated.

Copy link
Member

@naotoj naotoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the changes

@openjdk openjdk bot added the ready Pull request is ready to be integrated label May 9, 2025
@mlbridge
Copy link

mlbridge bot commented May 9, 2025

Mailing list message from Jonathan Gibbons on compiler-dev:

As a point of history, a long time ago (including Peter Ah?'s time), it
was policy to use ASCII encoding, and not any richer character set.

Last time I looked, there was still some discrepancies in the makefiles
for the encoding used for `javac` and `javadoc`.

-- Jon

On 4/17/25 7:48 AM, Magnus Ihse Bursie wrote:

@magicus
Copy link
Member Author

magicus commented May 14, 2025

/integrate

@openjdk
Copy link

openjdk bot commented May 14, 2025

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

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label May 14, 2025
@openjdk openjdk bot closed this May 14, 2025
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels May 14, 2025
@openjdk
Copy link

openjdk bot commented May 14, 2025

@magicus Pushed as commit a3e094e.

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

@magicus magicus deleted the unicode-sequence-in-comments branch May 14, 2025 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

compiler compiler-dev@openjdk.org core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org integrated Pull request has been integrated

Development

Successfully merging this pull request may close these issues.

2 participants