[prev in list] [next in list] [prev in thread] [next in thread] 

List:       openjdk-jmx-dev
Subject:    jmx-dev RFR: 8298046: Fix hidden but significant trailing whitespace in properties files for service
From:       Magnus Ihse Bursie <ihse () openjdk ! org>
Date:       2022-12-02 16:54:09
Message-ID: 5zDsJcRoc-qspV7yCf2m27PCmIn3R7YsUhXZ-PBXZiI=.93d0d47d-2eb9-4011-814c-6ab40f2d0c9b () github ! com
[Download RAW message or body]

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.

-------------

Commit messages:
 - 8298046: Fix hidden but significant trailing whitespace in properties files for \
serviceability code

Changes: https://git.openjdk.org/jdk/pull/11490/files
 Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=11490&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8298046
  Stats: 28 lines in 16 files changed: 0 ins; 0 del; 28 mod
  Patch: https://git.openjdk.org/jdk/pull/11490.diff
  Fetch: git fetch https://git.openjdk.org/jdk pull/11490/head:pull/11490

PR: https://git.openjdk.org/jdk/pull/11490


[prev in list] [next in list] [prev in thread] [next in thread]