All the mail mirrored from lore.kernel.org
 help / color / mirror / Atom feed
From: "Rafael J. Wysocki" <rafael@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	"Rafael J. Wysocki" <rjw@rjwysocki.net>,
	Viresh Kumar <viresh.kumar@linaro.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux PM <linux-pm@vger.kernel.org>
Subject: Re: [PATCH v2 05/40] docs: admin-guide: pm: Use ASCII subset instead of UTF-8 alternate symbols
Date: Wed, 12 May 2021 15:53:44 +0200	[thread overview]
Message-ID: <CAJZ5v0hzCjqWUVYUJ9n4LHgGicD6XgAmLPj4EwPfUySvaFmZYA@mail.gmail.com> (raw)
In-Reply-To: <f24d5bd469a42f4a97b9fa5de13575698789dcd6.1620823573.git.mchehab+huawei@kernel.org>

On Wed, May 12, 2021 at 2:52 PM Mauro Carvalho Chehab
<mchehab+huawei@kernel.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@kernel.org>

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.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
>

  reply	other threads:[~2021-05-12 13:53 UTC|newest]

Thread overview: 128+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-12 12:50 [PATCH v2 00/40] Use ASCII subset instead of UTF-8 alternate symbols Mauro Carvalho Chehab
2021-05-12 12:50 ` [Intel-wired-lan] " Mauro Carvalho Chehab
2021-05-12 12:50 ` [Intel-gfx] " Mauro Carvalho Chehab
2021-05-12 12:50 ` Mauro Carvalho Chehab
2021-05-12 12:50 ` [f2fs-dev] " Mauro Carvalho Chehab
2021-05-12 12:50 ` Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 01/40] docs: hwmon: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 02/40] docs: admin-guide: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 03/40] docs: admin-guide: media: ipu3.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 04/40] docs: admin-guide: perf: imx-ddr.rst: " Mauro Carvalho Chehab
2021-05-12 12:50   ` Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 05/40] docs: admin-guide: pm: " Mauro Carvalho Chehab
2021-05-12 13:53   ` Rafael J. Wysocki [this message]
2021-05-12 12:50 ` [PATCH v2 06/40] docs: trace: coresight: coresight-etm4x-reference.rst: " Mauro Carvalho Chehab
2021-05-12 12:50   ` Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 07/40] docs: driver-api: ioctl.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 08/40] docs: driver-api: thermal: " Mauro Carvalho Chehab
2021-06-12 19:08   ` Daniel Lezcano
2021-05-12 12:50 ` [PATCH v2 09/40] docs: driver-api: media: drivers: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 10/40] docs: driver-api: firmware: other_interfaces.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 11/40] docs: fault-injection: nvme-fault-injection.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 12/40] docs: usb: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 13/40] docs: process: code-of-conduct.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 14/40] docs: userspace-api: media: fdl-appendix.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 15/40] docs: userspace-api: media: v4l: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 16/40] docs: userspace-api: media: dvb: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 17/40] docs: vm: zswap.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 18/40] docs: filesystems: f2fs.rst: " Mauro Carvalho Chehab
2021-05-12 12:50   ` [f2fs-dev] " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 19/40] docs: filesystems: ext4: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 20/40] docs: kernel-hacking: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 21/40] docs: hid: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 22/40] docs: security: tpm: tpm_event_log.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 23/40] docs: security: keys: trusted-encrypted.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 24/40] docs: networking: scaling.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 25/40] docs: networking: devlink: devlink-dpipe.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 26/40] docs: networking: device_drivers: " Mauro Carvalho Chehab
2021-05-12 12:50   ` [Intel-wired-lan] " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 27/40] docs: x86: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 28/40] docs: scheduler: sched-deadline.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 29/40] docs: power: powercap: powercap.rst: " Mauro Carvalho Chehab
2021-05-12 13:54   ` Rafael J. Wysocki
2021-05-12 12:50 ` [PATCH v2 30/40] docs: ABI: " Mauro Carvalho Chehab
2021-05-12 13:49   ` Sudeep Holla
2021-05-12 12:50 ` [PATCH v2 31/40] docs: PCI: acpi-info.rst: " Mauro Carvalho Chehab
2021-05-12 21:29   ` Bjorn Helgaas
2021-05-12 12:50 ` [PATCH v2 32/40] docs: gpu: " Mauro Carvalho Chehab
2021-05-12 12:50   ` [Intel-gfx] " Mauro Carvalho Chehab
2021-05-12 12:50   ` Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 33/40] docs: sound: kernel-api: writing-an-alsa-driver.rst: " Mauro Carvalho Chehab
2021-05-12 12:50   ` Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 34/40] docs: arm64: arm-acpi.rst: " Mauro Carvalho Chehab
2021-05-12 12:50   ` Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 35/40] docs: infiniband: tag_matching.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 36/40] docs: misc-devices: ibmvmc.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 37/40] docs: firmware-guide: acpi: lpit.rst: " Mauro Carvalho Chehab
2021-05-12 13:46   ` Rafael J. Wysocki
2021-05-12 12:50 ` [PATCH v2 38/40] docs: firmware-guide: acpi: dsd: graph.rst: " Mauro Carvalho Chehab
2021-05-12 13:46   ` Rafael J. Wysocki
2021-05-12 12:50 ` [PATCH v2 39/40] docs: virt: kvm: api.rst: " Mauro Carvalho Chehab
2021-05-12 12:50 ` [PATCH v2 40/40] docs: RCU: " Mauro Carvalho Chehab
2021-05-12 14:14 ` [Intel-gfx] [PATCH v2 00/40] " Theodore Ts'o
2021-05-12 14:14   ` [Intel-wired-lan] " Theodore Ts'o
2021-05-12 14:14   ` Theodore Ts'o
2021-05-12 14:14   ` Theodore Ts'o
2021-05-12 14:14   ` Theodore Ts'o
2021-05-12 14:14   ` [f2fs-dev] " Theodore Ts'o
2021-05-12 15:17   ` Mauro Carvalho Chehab
2021-05-12 15:17     ` [Intel-wired-lan] " Mauro Carvalho Chehab
2021-05-12 15:17     ` Mauro Carvalho Chehab
2021-05-12 15:17     ` [Intel-gfx] " Mauro Carvalho Chehab
2021-05-12 15:17     ` Mauro Carvalho Chehab
2021-05-12 15:17     ` Mauro Carvalho Chehab
2021-05-12 17:12     ` [Intel-gfx] " David Woodhouse
2021-05-12 17:12       ` [Intel-wired-lan] " David Woodhouse
2021-05-12 17:12       ` David Woodhouse
2021-05-12 17:12       ` David Woodhouse
2021-05-12 17:12       ` David Woodhouse
2021-05-12 17:07 ` [Intel-gfx] " David Woodhouse
2021-05-12 17:07   ` [Intel-wired-lan] " David Woodhouse
2021-05-12 17:07   ` David Woodhouse
2021-05-12 17:07   ` David Woodhouse
2021-05-12 17:07   ` David Woodhouse
2021-05-14  8:21   ` Mauro Carvalho Chehab
2021-05-14  8:21     ` [Intel-wired-lan] " Mauro Carvalho Chehab
2021-05-14  8:21     ` [Intel-gfx] " Mauro Carvalho Chehab
2021-05-14  8:21     ` Mauro Carvalho Chehab
2021-05-14  8:21     ` Mauro Carvalho Chehab
2021-05-14  8:21     ` [f2fs-dev] " Mauro Carvalho Chehab
2021-05-14  9:06     ` [Intel-gfx] " David Woodhouse
2021-05-14  9:06       ` [Intel-wired-lan] " David Woodhouse
2021-05-14  9:06       ` David Woodhouse
2021-05-14  9:06       ` David Woodhouse
2021-05-14  9:06       ` David Woodhouse
2021-05-14 11:08       ` [f2fs-dev] " Edward Cree
2021-05-14 11:08         ` [Intel-wired-lan] " Edward Cree
2021-05-14 11:08         ` [Intel-gfx] " Edward Cree
2021-05-14 11:08         ` Edward Cree
2021-05-14 11:08         ` Edward Cree
2021-05-14 11:08         ` Edward Cree
2021-05-14 14:18         ` [f2fs-dev] " Mauro Carvalho Chehab
2021-05-14 14:18           ` [Intel-wired-lan] " Mauro Carvalho Chehab
2021-05-14 14:18           ` [Intel-gfx] " Mauro Carvalho Chehab
2021-05-14 14:18           ` Mauro Carvalho Chehab
2021-05-14 14:18           ` Mauro Carvalho Chehab
2021-05-14 14:18           ` Mauro Carvalho Chehab
2021-05-15  8:22       ` Mauro Carvalho Chehab
2021-05-15  8:22         ` [Intel-wired-lan] " Mauro Carvalho Chehab
2021-05-15  8:22         ` [Intel-gfx] " Mauro Carvalho Chehab
2021-05-15  8:22         ` Mauro Carvalho Chehab
2021-05-15  8:22         ` [f2fs-dev] " Mauro Carvalho Chehab
2021-05-15  8:22         ` Mauro Carvalho Chehab
2021-05-15  9:24         ` [Intel-gfx] " David Woodhouse
2021-05-15  9:24           ` [Intel-wired-lan] " David Woodhouse
2021-05-15  9:24           ` David Woodhouse
2021-05-15  9:24           ` David Woodhouse
2021-05-15  9:24           ` David Woodhouse
2021-05-15 11:23           ` [f2fs-dev] " Mauro Carvalho Chehab
2021-05-15 11:23             ` [Intel-wired-lan] " Mauro Carvalho Chehab
2021-05-15 11:23             ` [Intel-gfx] " Mauro Carvalho Chehab
2021-05-15 11:23             ` Mauro Carvalho Chehab
2021-05-15 11:23             ` Mauro Carvalho Chehab
2021-05-15 11:23             ` Mauro Carvalho Chehab
2021-05-15 12:02             ` [Intel-gfx] " David Woodhouse
2021-05-15 12:02               ` [Intel-wired-lan] " David Woodhouse
2021-05-15 12:02               ` David Woodhouse
2021-05-15 12:02               ` David Woodhouse
2021-05-15 12:02               ` David Woodhouse

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAJZ5v0hzCjqWUVYUJ9n4LHgGicD6XgAmLPj4EwPfUySvaFmZYA@mail.gmail.com \
    --to=rafael@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=rjw@rjwysocki.net \
    --cc=viresh.kumar@linaro.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.