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

List:       openjdk-serviceability-dev
Subject:    Re: RFR: 8298046: Fix hidden but significant trailing whitespace in properties files for serviceabil
From:       Kevin Walls <kevinw () openjdk ! org>
Date:       2023-01-30 9:15:23
Message-ID: W4jLFf_JGCO3k2WuKctMLX4yJqSzPGG3LXigsupDP6Y=.c05174cd-bb71-475e-a446-a6cef6045b02 () github ! com
[Download RAW message or body]

On Fri, 2 Dec 2022 16:42:57 GMT, Magnus Ihse Bursie <ihse@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.

The suggestions from Chris look good, i.e. the trailing \u0020 were unintentional.

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

Marked as reviewed by kevinw (Committer).

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


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