[PATCH 0/5] Fix some UTF-8 bad usages

[PATCH 0/5] Fix some UTF-8 bad usages

[Mauro Carvalho Chehab]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=UTF-8, Size: 1720 bytes --]

This series follow up this past series:
	https://lore.kernel.org/lkml/cover.1620641727.git.mchehab+huawei@kernel.org/

Containing just the manual fixes from it. I'll respin the remaining
patches on a separate series.

Please note that patches 1 to 3 are identical to the ones posted
on the original series.

Patch 1 is special: it fixes some left-overs from a convertion
from cdrom-standard.tex: there, some characters that are
valid in C were converted to some visually similar UTF-8 by LaTeX.

Patch 2 remove U+00ac ('¬'): NOT SIGN characters at the end of
the first line of two files. No idea why those ended being there :-p

Patch 3 replaces:
	KernelVersion:»·3.3
by:
	KernelVersion:	3.3

which is the expected format for the KernelVersion field;

Patches 4 and 5 fix some bad usages of EM DASH/EN DASH on
places that it should be, instead, a normal hyphen. I suspect
that they ended being there due to the usage of some conversion
toolset.

Mauro Carvalho Chehab (5):
  docs: cdrom-standard.rst: get rid of uneeded UTF-8 chars
  docs: ABI: remove a meaningless UTF-8 character
  docs: ABI: remove some spurious characters
  docs: hwmon: tmp103.rst: fix bad usage of UTF-8 chars
  docs: networking: device_drivers: fix bad usage of UTF-8 chars

 .../obsolete/sysfs-kernel-fadump_registered   |  2 +-
 .../obsolete/sysfs-kernel-fadump_release_mem  |  2 +-
 Documentation/ABI/testing/sysfs-module        |  4 +--
 Documentation/cdrom/cdrom-standard.rst        | 30 +++++++++----------
 Documentation/hwmon/tmp103.rst                |  4 +--
 .../device_drivers/ethernet/intel/i40e.rst    |  4 +--
 .../device_drivers/ethernet/intel/iavf.rst    |  2 +-
 7 files changed, 24 insertions(+), 24 deletions(-)

-- 
2.30.2

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

[Mauro Carvalho Chehab]

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@kernel.org>
---
 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).
-- 
2.30.2

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

[Guenter Roeck]

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@kernel.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 ?

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).
> 

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

[Mauro Carvalho Chehab]

Hi Guenter,

Em Tue, 11 May 2021 11:55:53 -0700
Guenter Roeck <linux@roeck-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@kernel.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

Re: [PATCH 0/5] Fix some UTF-8 bad usages

[Jonathan Corbet]

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> This series follow up this past series:
> 	https://lore.kernel.org/lkml/cover.1620641727.git.mchehab+huawei@kernel.org/
>
> Containing just the manual fixes from it. I'll respin the remaining
> patches on a separate series.
>
> Please note that patches 1 to 3 are identical to the ones posted
> on the original series.
>
> Patch 1 is special: it fixes some left-overs from a convertion
> from cdrom-standard.tex: there, some characters that are
> valid in C were converted to some visually similar UTF-8 by LaTeX.
>
> Patch 2 remove U+00ac (''): NOT SIGN characters at the end of
> the first line of two files. No idea why those ended being there :-p
>
> Patch 3 replaces:
> 	KernelVersion:3.3
> by:
> 	KernelVersion:	3.3
>
> which is the expected format for the KernelVersion field;
>
> Patches 4 and 5 fix some bad usages of EM DASH/EN DASH on
> places that it should be, instead, a normal hyphen. I suspect
> that they ended being there due to the usage of some conversion
> toolset.
>
> Mauro Carvalho Chehab (5):
>   docs: cdrom-standard.rst: get rid of uneeded UTF-8 chars
>   docs: ABI: remove a meaningless UTF-8 character
>   docs: ABI: remove some spurious characters
>   docs: hwmon: tmp103.rst: fix bad usage of UTF-8 chars
>   docs: networking: device_drivers: fix bad usage of UTF-8 chars
>
>  .../obsolete/sysfs-kernel-fadump_registered   |  2 +-
>  .../obsolete/sysfs-kernel-fadump_release_mem  |  2 +-
>  Documentation/ABI/testing/sysfs-module        |  4 +--
>  Documentation/cdrom/cdrom-standard.rst        | 30 +++++++++----------
>  Documentation/hwmon/tmp103.rst                |  4 +--
>  .../device_drivers/ethernet/intel/i40e.rst    |  4 +--
>  .../device_drivers/ethernet/intel/iavf.rst    |  2 +-
>  7 files changed, 24 insertions(+), 24 deletions(-)

These seem pretty straightforward; I've applied the set, thanks.

jon