linux-kernel - Re: [PATCH 4/5] docs: hwmon: tmp103.rst: fix bad usage of UTF-8 chars

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Wed, 12 May 2021 07:33:30 +0200
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Guenter Roeck <linux@...ck-us.net>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Jean Delvare <jdelvare@...e.com>, linux-hwmon@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 4/5] docs: hwmon: tmp103.rst: fix bad usage of UTF-8
 chars

Hi Guenter,

Em Tue, 11 May 2021 11:55:53 -0700
Guenter Roeck <linux@...ck-us.net> escreveu:

> On 5/11/21 8:01 AM, Mauro Carvalho Chehab wrote:
> > While UTF-8 characters can be used at the Linux documentation,
> > the best is to use them only when ASCII doesn't offer a good replacement.
> > So, replace the occurences of the following UTF-8 characters:
> > 
> > 	- U+2013 ('–'): EN DASH
> > 
> > In this specific case, EN DASH was used instead of a minus
> > sign. So, replace it by a single hyphen.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>  
> 
> Confused. Is that supposed to replace the earlier patch (docs: hwmon:
> avoid using UTF-8 chars) ? I thought that was more comprehensive
> and just as valid. Anyway, should I drop that patch ?

If you applied already the previous patch, that's OK. Just ignore this
one.

It is just that, after some discussions around EM/EN DASH on
patch 00/53[1], I opted to split the changes on three parts:

	- UTF-8 fixes;
	- non DASH UTF-8 replacements;
	- EM/EN DASH.

in order to make easier for reviewers to discuss EM/EN DASH if needed.

-

[1] You can see the full thread at:

	https://lore.kernel.org/lkml/cover.1620641727.git.mchehab+huawei@kernel.org/

    In summary, my original patchset were replacing both
    EM/EN DASH to a single hyphen.

    Yet, several maintainers seem to prefer using "--" for EN DASH
    and either "--" or "---" for EM DASH.

    Neither -- nor --- would make any sense on tmp103.rst, as here it
    means a minus sign.
    

> 
> Guenter
> 
> > ---
> >   Documentation/hwmon/tmp103.rst | 4 ++--
> >   1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/hwmon/tmp103.rst b/Documentation/hwmon/tmp103.rst
> > index e195a7d14309..b3ef81475cf8 100644
> > --- a/Documentation/hwmon/tmp103.rst
> > +++ b/Documentation/hwmon/tmp103.rst
> > @@ -21,10 +21,10 @@ Description
> >   The TMP103 is a digital output temperature sensor in a four-ball
> >   wafer chip-scale package (WCSP). The TMP103 is capable of reading
> >   temperatures to a resolution of 1°C. The TMP103 is specified for
> > -operation over a temperature range of –40°C to +125°C.
> > +operation over a temperature range of -40°C to +125°C.
> >   
> >   Resolution: 8 Bits
> > -Accuracy: ±1°C Typ (–10°C to +100°C)
> > +Accuracy: ±1°C Typ (-10°C to +100°C)
> >   
> >   The driver provides the common sysfs-interface for temperatures (see
> >   Documentation/hwmon/sysfs-interface.rst under Temperatures).
> >   
> 



Thanks,
Mauro