linux-kernel - Re: [PATCH v2 30/40] docs: ABI: Use ASCII subset instead of UTF-8 alternate symbols

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]

Message-ID: <20210512134940.j7kxcb7cbv56ic6y@bogus>
Date:   Wed, 12 May 2021 14:49:40 +0100
From:   Sudeep Holla <sudeep.holla@....com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Sudeep Holla <sudeep.holla@....com>,
        Benson Leung <bleung@...omium.org>,
        Enric Balletbo i Serra <enric.balletbo@...labora.com>,
        Guenter Roeck <groeck@...omium.org>,
        Oded Gabbay <oded.gabbay@...il.com>,
        Steven Price <steven.price@....com>,
        Suzuki K Poulose <suzuki.poulose@....com>,
        Tom Rix <trix@...hat.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 30/40] docs: ABI: Use ASCII subset instead of UTF-8
 alternate symbols

On Wed, May 12, 2021 at 02:50:34PM +0200, Mauro Carvalho Chehab wrote:
> The conversion tools used during DocBook/LaTeX/Markdown->ReST conversion
> and some automatic rules which exists on certain text editors like
> LibreOffice turned ASCII characters into some UTF-8 alternatives that
> are better displayed on html and PDF.
> 
> While it is OK to use UTF-8 characters in Linux, it is better to
> use the ASCII subset instead of using an UTF-8 equivalent character
> as it makes life easier for tools like grep, and are easier to edit
> with the some commonly used text/source code editors.
> 
> Also, Sphinx already do such conversion automatically outside literal blocks:
>    https://docutils.sourceforge.io/docs/user/smartquotes.html
> 
> So, replace the occurences of the following UTF-8 characters:
> 
> 	- U+2018 ('‘'): LEFT SINGLE QUOTATION MARK
> 	- U+2019 ('’'): RIGHT SINGLE QUOTATION MARK
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

[...]

I think I copy pasted the text from elsewhere, there is no way I managed
to type that 😄. Anyways, for the change in sysfs-devices-soc:

Acked-by: Sudeep Holla <sudeep.holla@....com>

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

-- 
Regards,
Sudeep