linux-kernel - Re: [PATCH 41/53] docs: ABI: avoid using 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] [thread-next>] [day] [month] [year] [list]
Date:   Mon, 10 May 2021 06:53:30 -0700
From:   Guenter Roeck <groeck@...gle.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Benson Leung <bleung@...omium.org>,
        Enric Balletbo i Serra <enric.balletbo@...labora.com>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Guenter Roeck <groeck@...omium.org>,
        Steven Price <steven.price@....com>,
        Sudeep Holla <sudeep.holla@....com>,
        Suzuki K Poulose <suzuki.poulose@....com>,
        Tom Rix <trix@...hat.com>,
        Vaibhav Jain <vaibhav@...ux.ibm.com>,
        linux-kernel <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 41/53] docs: ABI: avoid using UTF-8 chars

On Mon, May 10, 2021 at 3:27 AM Mauro Carvalho Chehab
<mchehab+huawei@...nel.org> 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
>         - U+2018 ('‘'): LEFT SINGLE QUOTATION MARK
>         - U+2019 ('’'): RIGHT SINGLE QUOTATION MARK
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Reviewed-by: Guenter Roeck <groeck@...omium.org>

> ---
>  .../ABI/testing/sysfs-class-chromeos-driver-cros-ec-lightbar  | 2 +-
>  Documentation/ABI/testing/sysfs-class-net-cdc_ncm             | 2 +-
>  Documentation/ABI/testing/sysfs-devices-platform-ipmi         | 2 +-
>  Documentation/ABI/testing/sysfs-devices-platform-trackpoint   | 2 +-
>  Documentation/ABI/testing/sysfs-devices-soc                   | 4 ++--
>  5 files changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-class-chromeos-driver-cros-ec-lightbar b/Documentation/ABI/testing/sysfs-class-chromeos-driver-cros-ec-lightbar
> index 57a037791403..a7fb8f1169f2 100644
> --- a/Documentation/ABI/testing/sysfs-class-chromeos-driver-cros-ec-lightbar
> +++ b/Documentation/ABI/testing/sysfs-class-chromeos-driver-cros-ec-lightbar
> @@ -29,7 +29,7 @@ KernelVersion:        4.2
>  Description:
>                 This allows you to control each LED segment. If the
>                 lightbar is already running one of the automatic
> -               sequences, you probably won’t see anything change because
> +               sequences, you probably won't see anything change because
>                 your color setting will be almost immediately replaced.
>                 To get useful results, you should stop the lightbar
>                 sequence first.
> diff --git a/Documentation/ABI/testing/sysfs-class-net-cdc_ncm b/Documentation/ABI/testing/sysfs-class-net-cdc_ncm
> index 06416d0e163d..41a1eef0d0e7 100644
> --- a/Documentation/ABI/testing/sysfs-class-net-cdc_ncm
> +++ b/Documentation/ABI/testing/sysfs-class-net-cdc_ncm
> @@ -93,7 +93,7 @@ Contact:      Bjørn Mork <bjorn@...k.no>
>  Description:
>                 - Bit 0: 16-bit NTB supported (set to 1)
>                 - Bit 1: 32-bit NTB supported
> -               - Bits 2 – 15: reserved (reset to zero; must be ignored by host)
> +               - Bits 2 - 15: reserved (reset to zero; must be ignored by host)
>
>  What:          /sys/class/net/<iface>/cdc_ncm/dwNtbInMaxSize
>  Date:          May 2014
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-ipmi b/Documentation/ABI/testing/sysfs-devices-platform-ipmi
> index 07df0ddc0b69..3935cdedea0e 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-ipmi
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-ipmi
> @@ -52,7 +52,7 @@ Date:         Mar, 2006
>  KernelVersion: v2.6.17
>  Contact:       openipmi-developer@...ts.sourceforge.net
>  Description:
> -               (RO) Lists the IPMI ‘logical device’ commands and functions
> +               (RO) Lists the IPMI 'logical device' commands and functions
>                 that the controller supports that are in addition to the
>                 mandatory IPM and Application commands.
>
> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-trackpoint b/Documentation/ABI/testing/sysfs-devices-platform-trackpoint
> index df11901a6b3d..82a38ac0435c 100644
> --- a/Documentation/ABI/testing/sysfs-devices-platform-trackpoint
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-trackpoint
> @@ -105,7 +105,7 @@ KernelVersion:      3.19
>  Contact:       linux-input@...r.kernel.org
>  Description:
>                 (RW) This parameter controls the period of time to test for a
> -               ‘hands off’ condition (i.e. when no force is applied) before a
> +               'hands off' condition (i.e. when no force is applied) before a
>                 drift (noise) calibration occurs.
>
>                 IBM Trackpoints have a feature to compensate for drift by
> diff --git a/Documentation/ABI/testing/sysfs-devices-soc b/Documentation/ABI/testing/sysfs-devices-soc
> index ea999e292f11..7f90c6a44610 100644
> --- a/Documentation/ABI/testing/sysfs-devices-soc
> +++ b/Documentation/ABI/testing/sysfs-devices-soc
> @@ -27,11 +27,11 @@ Description:
>                 (e.g. DB8500).
>
>                 On many of ARM based silicon with SMCCC v1.2+ compliant firmware
> -               this will contain the JEDEC JEP106 manufacturer’s identification
> +               this will contain the JEDEC JEP106 manufacturer's identification
>                 code. The format is "jep106:XXYY" where XX is identity code and
>                 YY is continuation code.
>
> -               This manufacturer’s identification code is defined by one
> +               This manufacturer's identification code is defined by one
>                 or more eight (8) bit fields, each consisting of seven (7)
>                 data bits plus one (1) odd parity bit. It is a single field,
>                 limiting the possible number of vendors to 126. To expand
> --
> 2.30.2
>