linux-kernel - Re: [PATCH v2 05/40] docs: admin-guide: pm: 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: <CAJZ5v0hzCjqWUVYUJ9n4LHgGicD6XgAmLPj4EwPfUySvaFmZYA@mail.gmail.com>
Date:   Wed, 12 May 2021 15:53:44 +0200
From:   "Rafael J. Wysocki" <rafael@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Viresh Kumar <viresh.kumar@...aro.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux PM <linux-pm@...r.kernel.org>
Subject: Re: [PATCH v2 05/40] docs: admin-guide: pm: Use ASCII subset instead
 of UTF-8 alternate symbols

On Wed, May 12, 2021 at 2:52 PM Mauro Carvalho Chehab
<mchehab+huawei@...nel.org> 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+2019 ('’'): RIGHT SINGLE QUOTATION MARK
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@...el.com>

> ---
>  Documentation/admin-guide/pm/intel_idle.rst   | 4 ++--
>  Documentation/admin-guide/pm/intel_pstate.rst | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/admin-guide/pm/intel_idle.rst b/Documentation/admin-guide/pm/intel_idle.rst
> index 89309e1b0e48..c3c4f5d4c806 100644
> --- a/Documentation/admin-guide/pm/intel_idle.rst
> +++ b/Documentation/admin-guide/pm/intel_idle.rst
> @@ -28,7 +28,7 @@ logical CPU executing it is idle and so it may be possible to put some of the
>  processor's functional blocks into low-power states.  That instruction takes two
>  arguments (passed in the ``EAX`` and ``ECX`` registers of the target CPU), the
>  first of which, referred to as a *hint*, can be used by the processor to
> -determine what can be done (for details refer to Intel Software Developer’s
> +determine what can be done (for details refer to Intel Software Developer's
>  Manual [1]_).  Accordingly, ``intel_idle`` refuses to work with processors in
>  which the support for the ``MWAIT`` instruction has been disabled (for example,
>  via the platform firmware configuration menu) or which do not support that
> @@ -261,7 +261,7 @@ restrict the range of permissible idle states to the ones with core-level only
>  References
>  ==========
>
> -.. [1] *Intel® 64 and IA-32 Architectures Software Developer’s Manual Volume 2B*,
> +.. [1] *Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 2B*,
>         https://www.intel.com/content/www/us/en/architecture-and-technology/64-ia-32-architectures-software-developer-vol-2b-manual.html
>
>  .. [2] *Advanced Configuration and Power Interface (ACPI) Specification*,
> diff --git a/Documentation/admin-guide/pm/intel_pstate.rst b/Documentation/admin-guide/pm/intel_pstate.rst
> index df29b4f1f219..d881a32acb6d 100644
> --- a/Documentation/admin-guide/pm/intel_pstate.rst
> +++ b/Documentation/admin-guide/pm/intel_pstate.rst
> @@ -26,7 +26,7 @@ than just an operating frequency or an operating performance point (see the
>  LinuxCon Europe 2015 presentation by Kristen Accardi [1]_ for more
>  information about that).  For this reason, the representation of P-states used
>  by ``intel_pstate`` internally follows the hardware specification (for details
> -refer to Intel Software Developer’s Manual [2]_).  However, the ``CPUFreq`` core
> +refer to Intel Software Developer's Manual [2]_).  However, the ``CPUFreq`` core
>  uses frequencies for identifying operating performance points of CPUs and
>  frequencies are involved in the user space interface exposed by it, so
>  ``intel_pstate`` maps its internal representation of P-states to frequencies too
> @@ -756,7 +756,7 @@ References
>  .. [1] Kristen Accardi, *Balancing Power and Performance in the Linux Kernel*,
>         https://events.static.linuxfound.org/sites/events/files/slides/LinuxConEurope_2015.pdf
>
> -.. [2] *Intel® 64 and IA-32 Architectures Software Developer’s Manual Volume 3: System Programming Guide*,
> +.. [2] *Intel® 64 and IA-32 Architectures Software Developer's Manual Volume 3: System Programming Guide*,
>         https://www.intel.com/content/www/us/en/architecture-and-technology/64-ia-32-architectures-software-developer-system-programming-manual-325384.html
>
>  .. [3] *Advanced Configuration and Power Interface Specification*,
> --
> 2.30.2
>