RFR: 8298046: Fix hidden but significant trailing whitespace in properties files for serviceability code
Magnus Ihse Bursie
ihse at openjdk.org
Mon Feb 5 16:58:56 UTC 2024
On Tue, 28 Mar 2023 17:36:33 GMT, Chris Plummer <cjplummer at openjdk.org> wrote:
>> According to [the specification](https://docs.oracle.com/en/java/javase/19/docs/api/java.base/java/util/Properties.html#load(java.io.Reader)) trailing whitespaces in the values of properties files are (somewhat surprisingly) actually significant.
>>
>> We have multiple files in the JDK with trailing whitespaces in the values. For most of this files, this is likely incorrect and due to oversight, but in a few cases it might actually be intended (like "The value is: ").
>>
>> After a discussion in the PR for [JDK-8295729](https://bugs.openjdk.org/browse/JDK-8295729), the consensus was to replace valid trailing spaces with the corresponding unicode sequence, `\u0020`. (And of course remove non-wanted trailing spaces.)
>>
>> Doing so has a dual benefit:
>>
>> 1) It makes it clear to everyone reading the code that there is a trailing space and it is intended
>>
>> 2) It will allow us to remove all actual trailing space characters, and turn on the corresponding check in jcheck to keep the properties files, just like all other source code files, free of trailing spaces.
>>
>> Ultimately, the call of whether a trailing space is supposed to be there, or is a bug, lies with the respective component teams owning these files. Thus I have split up the set of properties files with trailing spaces in several groups, to match the JDK teams, and open a JBS issue for each of them. This issue is for code I believe belong with the serviceability team.
>
> What was the reason for not moving forward with this PR?
Several of the original problems has been resolved since this PR was opened, but some remain. I believe this is now ready for integration, but I'd like to get a re-review from @plummercj.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/11490#issuecomment-1927469254
More information about the serviceability-dev
mailing list