From: Bjorn Helgaas <helgaas@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>,
"Bjorn Helgaas" <bhelgaas@google.com>,
linux-kernel@vger.kernel.org, linux-pci@vger.kernel.org,
"Krzysztof Wilczyński" <kw@linux.com>
Subject: Re: [PATCH v2 31/40] docs: PCI: acpi-info.rst: Use ASCII subset instead of UTF-8 alternate symbols
Date: Wed, 12 May 2021 16:29:38 -0500 [thread overview]
Message-ID: <20210512212938.GA2516413@bjorn-Precision-5520> (raw)
In-Reply-To: <7fd9d4360a3d0f761b169b95d9997f4f5d06319c.1620823573.git.mchehab+huawei@kernel.org>
1) The subject line convention in Documentation/PCI has been
"Documentation: PCI: ...", but that is a little wordy, and if you want
to start a wider convention of "docs: PCI: ..." I'm OK with that.
2) IMO, including the filename ("acpi-info.rst") in the subject is not
really all that interesting. In fact, I'd be fine with doing this
sort of mechanical conversion with a patch per directory or even a
single patch for *all* of Documentation/.
On Wed, May 12, 2021 at 02:50:35PM +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+00a0 (' '): NO-BREAK SPACE
> - U+2019 ('’'): RIGHT SINGLE QUOTATION MARK
>
> Reviewed-by: Krzysztof Wilczyński <kw@linux.com>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Yes, this is annoying. Thanks for doing this.
I noticed a few other anomalies. If you want to keep this series as
just a mechanical thing and leave the things below for later, I'm OK
with that, too.
Acked-by: Bjorn Helgaas <bhelgaas@google.com>
> ---
> Documentation/PCI/acpi-info.rst | 22 +++++++++++-----------
> 1 file changed, 11 insertions(+), 11 deletions(-)
>
> diff --git a/Documentation/PCI/acpi-info.rst b/Documentation/PCI/acpi-info.rst
> index 060217081c79..30d0fc85dd8e 100644
> --- a/Documentation/PCI/acpi-info.rst
> +++ b/Documentation/PCI/acpi-info.rst
> @@ -22,9 +22,9 @@ or if the device has INTx interrupts connected by platform interrupt
> controllers and a _PRT is needed to describe those connections.
>
> ACPI resource description is done via _CRS objects of devices in the ACPI
> -namespace [2]. The _CRS is like a generalized PCI BAR: the OS can read
> +namespace [2]. The _CRS is like a generalized PCI BAR: the OS can read
s/ The _CRS/ The _CRS/
Remove one of the spaces at the end of this sentence. One space is
OK, two is the convention in this file, and three is way too many :)
> @@ -66,7 +66,7 @@ the PNP0A03/PNP0A08 device itself. The workaround was to describe the
> bridge registers (including ECAM space) in PNP0C02 catch-all devices [6].
> With the exception of ECAM, the bridge register space is device-specific
> anyway, so the generic PNP0A03/PNP0A08 driver (pci_root.c) has no need to
> -know about it.
> +know about it.
Remove all the whitespace at the end of this line.
Bjorn
next prev parent reply other threads:[~2021-05-12 22:19 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
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 [this message]
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=20210512212938.GA2516413@bjorn-Precision-5520 \
--to=helgaas@kernel.org \
--cc=bhelgaas@google.com \
--cc=corbet@lwn.net \
--cc=kw@linux.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=mchehab+huawei@kernel.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.