8298943: Missing escapes for single quote marks in compiler.properties

[archiecobbs]

The source file compiler.properties contains the English message bundle for compiler warnings, errors, etc.

Since the strings in this file are format strings, any single quotes must be escaped by doubling them.

An example of a properly encoded entry is:

compiler.err.cant.assign.val.to.this=\
    cannot assign to ''this''

There are three entries that appear to be not escaped when they should be.

---

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-8298943: Missing escapes for single quote marks in compiler.properties

Reviewers

• Jonathan Gibbons (@jonathan-gibbons - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11712

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

Using diff file

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

[bridgekeeper]

👋 Welcome back archiecobbs! 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]

@archiecobbs The following label will be automatically applied to this pull request:

• compiler

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

• 03: Full - Incremental (ec386574)
• 02: Full - Incremental (fe523617)
• 01: Full - Incremental (c01be470)
• 00: Full (e427291c)

[jonathan-gibbons]

@archiecobbs You need to fix the PR title.

An interesting followup might be to update the CheckResourceKeys test to proactively check for this error condition.

[openjdk]

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

8298943: Missing escapes for single quote marks in compiler.properties

Reviewed-by: jjg

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:

• 9194e91: 8298701: Cleanup SA entries in ProblemList-zgc.txt.
• 4c927df: 8298470: Short cut java.lang.Object super class loading
• 756a06d: 8299022: Linux ppc64le and s390x build issues after JDK-8160404
• de0ce79: 8297801: printnm crashes with invalid address due to null pointer dereference

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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@jonathan-gibbons) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[archiecobbs]

An interesting followup might be to update the CheckResourceKeys test to proactively check for this error condition.

Great idea... and no reason not to check for overall MessageFormat syntactical correctness since we effectively must replicate its (simplistic & quirky) parsing algorithm to do this.

Added in c01be47.

[jonathan-gibbons]

I'm guessing you copied it, not cut it .... :-)

[jonathan-gibbons]

Thanks for adding in the check.

At some point (not here and now in this review) we should maybe try and merge this with the copy-pasted version for javadoc, also called CheckResourceKeys. Filed as JDK-8299042

[archiecobbs]

At some point (not here and now in this review) we should maybe try and merge this with the copy-pasted version for javadoc, also called CheckResourceKeys.

Agreed... and to expand/digress even further, what would really be nice is for MessageFormat to make its double secret parsing algorithm (which supports arbitrarily many levels of nesting) available to the general public somehow. This would make it easier to develop tools related to format strings (see also this class which relies on introspection hacks).

Thanks for the review.

/integrate

[openjdk]

@archiecobbs
Your change (at version ec38657) is now ready to be sponsored by a Committer.

[jonathan-gibbons]

/sponsor

[openjdk]

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

• 9194e91: 8298701: Cleanup SA entries in ProblemList-zgc.txt.
• 4c927df: 8298470: Short cut java.lang.Object super class loading
• 756a06d: 8299022: Linux ppc64le and s390x build issues after JDK-8160404
• de0ce79: 8297801: printnm crashes with invalid address due to null pointer dereference

Your commit was automatically rebased without conflicts.

[openjdk]

@jonathan-gibbons @archiecobbs Pushed as commit 40cb431.

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

[jonathan-gibbons]

At some point (not here and now in this review) we should maybe try and merge this with the copy-pasted version for javadoc, also called CheckResourceKeys.

A different JDK-specific place to put the format checks might be the properties compiler used in the JDK build to convert resource files from .properties format to compiled Java classes.