* [PATCH v3 00/16] Replace some bad characters on documents
@ 2021-05-16 10:18 Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 12/16] docs: PCI: acpi-info.rst: replace some characters Mauro Carvalho Chehab
2021-05-17 10:48 ` [PATCH v3 00/16] Replace some bad characters on documents David Woodhouse
0 siblings, 2 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-16 10:18 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
David S. Miller, Theodore Ts'o, Alan Stern, Andreas Dilger,
Corentin Labbe, Guenter Roeck, Jakub Kicinski, Jaroslav Kysela,
Jean Delvare, Joel Fernandes, Lai Jiangshan, Leo Yan,
Mathieu Desnoyers, Mathieu Poirier, Mauro Carvalho Chehab,
Mike Leach, Steven Rostedt, Suzuki K Poulose, Thorsten Leemhuis,
alsa-devel, coresight, intel-wired-lan, kvm, linux-acpi,
linux-arm-kernel, linux-ext4, linux-hwmon, linux-media,
linux-pci, linux-usb, mjpeg-users, netdev, rcu
The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
conversion and some cut-and-pasted text contain some characters that
aren't easily reachable on standard keyboards and/or could cause
troubles when parsed by the documentation build system.
Replace the occurences of the following characters:
- U+00a0 (' '): NO-BREAK SPACE
- U+00ad (''): SOFT HYPHEN
- U+2010 ('‐'): HYPHEN
- U+2217 ('∗'): ASTERISK OPERATOR
- U+feff (''): BOM
I'll submit in separate another series to address other character occurrences.
v3:
- removed curly commas and changed the patch descriptions.
v2:
- removed EM/EN dashes and changed the patch descriptions.
Mauro Carvalho Chehab (16):
docs: hwmon: ir36021.rst: replace some characters
docs: admin-guide: reporting-issues.rst: replace some characters
docs: trace: coresight: coresight-etm4x-reference.rst: replace some
characters
docs: driver-api: ioctl.rst: replace some characters
docs: driver-api: media: drivers: zoran.rst: replace some characters
docs: usb: replace some characters
docs: userspace-api: media: v4l: dev-decoder.rst: replace some
characters
docs: userspace-api: media: dvb: intro.rst: replace some characters
docs: vm: zswap.rst: replace some characters
docs: filesystems: ext4: blockgroup.rst: replace some characters
docs: networking: device_drivers: replace some characters
docs: PCI: acpi-info.rst: replace some characters
docs: sound: kernel-api: writing-an-alsa-driver.rst: replace some
characters
docs: firmware-guide: acpi: dsd: graph.rst: replace some characters
docs: virt: kvm: api.rst: replace some characters
docs: RCU: replace some characters
Documentation/PCI/acpi-info.rst | 18 ++---
.../Data-Structures/Data-Structures.rst | 46 ++++++------
.../Expedited-Grace-Periods.rst | 36 +++++-----
.../Tree-RCU-Memory-Ordering.rst | 2 +-
.../RCU/Design/Requirements/Requirements.rst | 70 +++++++++----------
.../admin-guide/reporting-issues.rst | 2 +-
Documentation/driver-api/ioctl.rst | 8 +--
.../driver-api/media/drivers/zoran.rst | 2 +-
Documentation/filesystems/ext4/blockgroup.rst | 2 +-
.../firmware-guide/acpi/dsd/graph.rst | 2 +-
Documentation/hwmon/ir36021.rst | 2 +-
.../device_drivers/ethernet/intel/i40e.rst | 6 +-
.../device_drivers/ethernet/intel/iavf.rst | 2 +-
.../kernel-api/writing-an-alsa-driver.rst | 2 +-
.../coresight/coresight-etm4x-reference.rst | 2 +-
Documentation/usb/ehci.rst | 2 +-
Documentation/usb/gadget_printer.rst | 2 +-
.../userspace-api/media/dvb/intro.rst | 4 +-
.../userspace-api/media/v4l/dev-decoder.rst | 2 +-
Documentation/virt/kvm/api.rst | 28 ++++----
Documentation/vm/zswap.rst | 4 +-
21 files changed, 122 insertions(+), 122 deletions(-)
--
2.31.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v3 12/16] docs: PCI: acpi-info.rst: replace some characters
2021-05-16 10:18 [PATCH v3 00/16] Replace some bad characters on documents Mauro Carvalho Chehab
@ 2021-05-16 10:18 ` Mauro Carvalho Chehab
2021-05-19 21:47 ` Bjorn Helgaas
2021-05-17 10:48 ` [PATCH v3 00/16] Replace some bad characters on documents David Woodhouse
1 sibling, 1 reply; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-16 10:18 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Bjorn Helgaas,
linux-kernel, linux-pci
The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
conversion and some cut-and-pasted text contain some characters that
aren't easily reachable on standard keyboards and/or could cause
troubles when parsed by the documentation build system.
Replace the occurences of the following characters:
- U+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/PCI/acpi-info.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/Documentation/PCI/acpi-info.rst b/Documentation/PCI/acpi-info.rst
index 060217081c79..34c64a5a66ec 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
_CRS and figure out what resource is being consumed even if it doesn't have
-a driver for the device [3]. That's important because it means an old OS
+a driver for the device [3]. That's important because it means an old OS
can work correctly even on a system with new devices unknown to the OS.
The new devices might not do anything, but the OS can at least make sure no
resources conflict with them.
@@ -41,15 +41,15 @@ ACPI, that device will have a specific _HID/_CID that tells the OS what
driver to bind to it, and the _CRS tells the OS and the driver where the
device's registers are.
-PCI host bridges are PNP0A03 or PNP0A08 devices. Their _CRS should
-describe all the address space they consume. This includes all the windows
+PCI host bridges are PNP0A03 or PNP0A08 devices. Their _CRS should
+describe all the address space they consume. This includes all the windows
they forward down to the PCI bus, as well as registers of the host bridge
-itself that are not forwarded to PCI. The host bridge registers include
+itself that are not forwarded to PCI. The host bridge registers include
things like secondary/subordinate bus registers that determine the bus
range below the bridge, window registers that describe the apertures, etc.
These are all device-specific, non-architected things, so the only way a
PNP0A03/PNP0A08 driver can manage them is via _PRS/_CRS/_SRS, which contain
-the device-specific details. The host bridge registers also include ECAM
+the device-specific details. The host bridge registers also include ECAM
space, since it is consumed by the host bridge.
ACPI defines a Consumer/Producer bit to distinguish the bridge registers
@@ -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.
New architectures should be able to use "Consumer" Extended Address Space
descriptors in the PNP0A03 device for bridge registers, including ECAM,
@@ -75,9 +75,9 @@ ia64 kernels assume all address space descriptors, including "Consumer"
Extended Address Space ones, are windows, so it would not be safe to
describe bridge registers this way on those architectures.
-PNP0C02 "motherboard" devices are basically a catch-all. There's no
+PNP0C02 "motherboard" devices are basically a catch-all. There's no
programming model for them other than "don't use these resources for
-anything else." So a PNP0C02 _CRS should claim any address space that is
+anything else." So a PNP0C02 _CRS should claim any address space that is
(1) not claimed by _CRS under any other device object in the ACPI namespace
and (2) should not be assigned by the OS to something else.
--
2.31.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH v3 00/16] Replace some bad characters on documents
2021-05-16 10:18 [PATCH v3 00/16] Replace some bad characters on documents Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 12/16] docs: PCI: acpi-info.rst: replace some characters Mauro Carvalho Chehab
@ 2021-05-17 10:48 ` David Woodhouse
2021-05-17 11:24 ` Mauro Carvalho Chehab
1 sibling, 1 reply; 6+ messages in thread
From: David Woodhouse @ 2021-05-17 10:48 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: linux-kernel, Jonathan Corbet, David S. Miller,
Theodore Ts'o, Alan Stern, Andreas Dilger, Corentin Labbe,
Guenter Roeck, Jakub Kicinski, Jaroslav Kysela, Jean Delvare,
Joel Fernandes, Lai Jiangshan, Leo Yan, Mathieu Desnoyers,
Mathieu Poirier, Mauro Carvalho Chehab, Mike Leach,
Steven Rostedt, Suzuki K Poulose, Thorsten Leemhuis, alsa-devel,
coresight, intel-wired-lan, kvm, linux-acpi, linux-arm-kernel,
linux-ext4, linux-hwmon, linux-media, linux-pci, linux-usb,
mjpeg-users, netdev, rcu
[-- Attachment #1: Type: text/plain, Size: 532 bytes --]
On Sun, 2021-05-16 at 12:18 +0200, Mauro Carvalho Chehab wrote:
> The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
> conversion and some cut-and-pasted text contain some characters that
> aren't easily reachable on standard keyboards and/or could cause
> troubles when parsed by the documentation build system.
Better.
But you still don't say *why* it matters whether given characters are
trivial to reach with standard keyboard layouts, or specify *what*
'troubles' the offending characters cause.
[-- Attachment #2: smime.p7s --]
[-- Type: application/x-pkcs7-signature, Size: 5174 bytes --]
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v3 00/16] Replace some bad characters on documents
2021-05-17 10:48 ` [PATCH v3 00/16] Replace some bad characters on documents David Woodhouse
@ 2021-05-17 11:24 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2021-05-17 11:24 UTC (permalink / raw)
To: David Woodhouse
Cc: Linux Doc Mailing List, linux-kernel, Jonathan Corbet,
David S. Miller, Theodore Ts'o, Alan Stern, Andreas Dilger,
Corentin Labbe, Guenter Roeck, Jakub Kicinski, Jaroslav Kysela,
Jean Delvare, Joel Fernandes, Lai Jiangshan, Leo Yan,
Mathieu Desnoyers, Mathieu Poirier, Mauro Carvalho Chehab,
Mike Leach, Steven Rostedt, Suzuki K Poulose, Thorsten Leemhuis,
alsa-devel, coresight, intel-wired-lan, kvm, linux-acpi,
linux-arm-kernel, linux-ext4, linux-hwmon, linux-media,
linux-pci, linux-usb, mjpeg-users, netdev, rcu
Em Mon, 17 May 2021 11:48:04 +0100
David Woodhouse <dwmw2@infradead.org> escreveu:
> On Sun, 2021-05-16 at 12:18 +0200, Mauro Carvalho Chehab wrote:
> > The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
> > conversion and some cut-and-pasted text contain some characters that
> > aren't easily reachable on standard keyboards and/or could cause
> > troubles when parsed by the documentation build system.
>
> Better.
>
> But you still don't say *why* it matters whether given characters are
> trivial to reach with standard keyboard layouts, or specify *what*
> 'troubles' the offending characters cause.
See the patches in the series. The reason for each particular case
is there on each patch, like on this one:
[PATCH v3 13/16] docs: sound: kernel-api: writing-an-alsa-driver.rst: replace some characters
The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
conversion and some cut-and-pasted text contain some characters that
aren't easily reachable on standard keyboards and/or could cause
troubles when parsed by the documentation build system.
Replace the occurences of the following characters:
- U+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thanks,
Mauro
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v3 12/16] docs: PCI: acpi-info.rst: replace some characters
2021-05-16 10:18 ` [PATCH v3 12/16] docs: PCI: acpi-info.rst: replace some characters Mauro Carvalho Chehab
@ 2021-05-19 21:47 ` Bjorn Helgaas
2021-06-16 6:51 ` Mauro Carvalho Chehab
0 siblings, 1 reply; 6+ messages in thread
From: Bjorn Helgaas @ 2021-05-19 21:47 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Jonathan Corbet, Bjorn Helgaas,
linux-kernel, linux-pci
On Sun, May 16, 2021 at 12:18:29PM +0200, Mauro Carvalho Chehab wrote:
> The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
> conversion and some cut-and-pasted text contain some characters that
> aren't easily reachable on standard keyboards and/or could cause
> troubles when parsed by the documentation build system.
>
> Replace the occurences of the following characters:
>
> - U+00a0 (' '): NO-BREAK SPACE
> as it can cause lines being truncated on PDF output
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Apparently you missed
https://lore.kernel.org/r/20210512212938.GA2516413@bjorn-Precision-5520
where I pointed out a couple issues (3 spaces after period in first
hunk, extra whitespace at end of "know about it." hunk) and added my
ack.
The subject line would be more useful as:
docs: PCI: Replace non-breaking spaces to avoid PDF issues
It's fine to defer those issues if you want, but this is still:
Acked-by: Bjorn Helgaas <bhelgaas@google.com>
> ---
> Documentation/PCI/acpi-info.rst | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/PCI/acpi-info.rst b/Documentation/PCI/acpi-info.rst
> index 060217081c79..34c64a5a66ec 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
> _CRS and figure out what resource is being consumed even if it doesn't have
> -a driver for the device [3]. That's important because it means an old OS
> +a driver for the device [3]. That's important because it means an old OS
> can work correctly even on a system with new devices unknown to the OS.
> The new devices might not do anything, but the OS can at least make sure no
> resources conflict with them.
> @@ -41,15 +41,15 @@ ACPI, that device will have a specific _HID/_CID that tells the OS what
> driver to bind to it, and the _CRS tells the OS and the driver where the
> device's registers are.
>
> -PCI host bridges are PNP0A03 or PNP0A08 devices. Their _CRS should
> -describe all the address space they consume. This includes all the windows
> +PCI host bridges are PNP0A03 or PNP0A08 devices. Their _CRS should
> +describe all the address space they consume. This includes all the windows
> they forward down to the PCI bus, as well as registers of the host bridge
> -itself that are not forwarded to PCI. The host bridge registers include
> +itself that are not forwarded to PCI. The host bridge registers include
> things like secondary/subordinate bus registers that determine the bus
> range below the bridge, window registers that describe the apertures, etc.
> These are all device-specific, non-architected things, so the only way a
> PNP0A03/PNP0A08 driver can manage them is via _PRS/_CRS/_SRS, which contain
> -the device-specific details. The host bridge registers also include ECAM
> +the device-specific details. The host bridge registers also include ECAM
> space, since it is consumed by the host bridge.
>
> ACPI defines a Consumer/Producer bit to distinguish the bridge registers
> @@ -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.
>
> New architectures should be able to use "Consumer" Extended Address Space
> descriptors in the PNP0A03 device for bridge registers, including ECAM,
> @@ -75,9 +75,9 @@ ia64 kernels assume all address space descriptors, including "Consumer"
> Extended Address Space ones, are windows, so it would not be safe to
> describe bridge registers this way on those architectures.
>
> -PNP0C02 "motherboard" devices are basically a catch-all. There's no
> +PNP0C02 "motherboard" devices are basically a catch-all. There's no
> programming model for them other than "don't use these resources for
> -anything else." So a PNP0C02 _CRS should claim any address space that is
> +anything else." So a PNP0C02 _CRS should claim any address space that is
> (1) not claimed by _CRS under any other device object in the ACPI namespace
> and (2) should not be assigned by the OS to something else.
>
> --
> 2.31.1
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v3 12/16] docs: PCI: acpi-info.rst: replace some characters
2021-05-19 21:47 ` Bjorn Helgaas
@ 2021-06-16 6:51 ` Mauro Carvalho Chehab
0 siblings, 0 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2021-06-16 6:51 UTC (permalink / raw)
To: Bjorn Helgaas
Cc: Linux Doc Mailing List, Jonathan Corbet, Bjorn Helgaas,
linux-kernel, linux-pci
Em Wed, 19 May 2021 16:47:31 -0500
Bjorn Helgaas <helgaas@kernel.org> escreveu:
> On Sun, May 16, 2021 at 12:18:29PM +0200, Mauro Carvalho Chehab wrote:
> > The conversion tools used during DocBook/LaTeX/html/Markdown->ReST
> > conversion and some cut-and-pasted text contain some characters that
> > aren't easily reachable on standard keyboards and/or could cause
> > troubles when parsed by the documentation build system.
> >
> > Replace the occurences of the following characters:
> >
> > - U+00a0 (' '): NO-BREAK SPACE
> > as it can cause lines being truncated on PDF output
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
>
> Apparently you missed
> https://lore.kernel.org/r/20210512212938.GA2516413@bjorn-Precision-5520
> where I pointed out a couple issues (3 spaces after period in first
> hunk, extra whitespace at end of "know about it." hunk) and added my
> ack.
>
> The subject line would be more useful as:
>
> docs: PCI: Replace non-breaking spaces to avoid PDF issues
>
> It's fine to defer those issues if you want,
Yeah, I opted to separate the changes into parts. This one is focused
on problematic chars that could lead into output issues.
Once those get merged, I'll submit a separate one with things like curly
commas and dashes, as a couple of maintainers seem to have different
opinions about that.
> but this is still:
>
> Acked-by: Bjorn Helgaas <bhelgaas@google.com>
Thanks!
Regards,
Mauro
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-06-16 6:51 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-16 10:18 [PATCH v3 00/16] Replace some bad characters on documents Mauro Carvalho Chehab
2021-05-16 10:18 ` [PATCH v3 12/16] docs: PCI: acpi-info.rst: replace some characters Mauro Carvalho Chehab
2021-05-19 21:47 ` Bjorn Helgaas
2021-06-16 6:51 ` Mauro Carvalho Chehab
2021-05-17 10:48 ` [PATCH v3 00/16] Replace some bad characters on documents David Woodhouse
2021-05-17 11:24 ` Mauro Carvalho Chehab
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).