Replace some bad characters on documents
Subsystems (10)
cover Replace some bad characters on documents
Hi Jon,
This series contain the remaining 8 patches I submitted at v3 that weren't merged yet at -next.
This series is rebased on the top of your docs-next branch.
No changes here, except by some Reviewed/ack lines, and at the name of the final patch (per PCI maintainer's request).
Mauro Carvalho Chehab (8):
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: usb: 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: Replace non-breaking spaces to avoid PDF issues
Documentation/PCI/acpi-info.rst | 18 +++++++++--------- Documentation/admin-guide/reporting-issues.rst | 2 +- Documentation/driver-api/ioctl.rst | 8 ++++---- Documentation/filesystems/ext4/blockgroup.rst | 2 +- .../device_drivers/ethernet/intel/i40e.rst | 6 +++--- .../device_drivers/ethernet/intel/iavf.rst | 2 +- .../coresight/coresight-etm4x-reference.rst | 2 +- Documentation/usb/ehci.rst | 2 +- Documentation/usb/gadget_printer.rst | 2 +- Documentation/vm/zswap.rst | 4 ++-- 10 files changed, 24 insertions(+), 24 deletions(-)
Signature · 1 line
2.31.1
PATCH 1/8 docs: admin-guide: reporting-issues.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
--- Documentation/admin-guide/reporting-issues.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/reporting-issues.rst +1 -1
@@ -1248,7 +1248,7 @@ paragraph makes the severeness obvious. In case you performed a successful bisection, use the title of the change that introduced the regression as the second part of your subject. Make the report -also mention the commit id of the culprit. In case of an unsuccessful bisection, +also mention the commit id of the culprit. In case of an unsuccessful bisection, make your report mention the latest tested version that's working fine (say 5.7) and the oldest where the issue occurs (say 5.8-rc1).
Signature · 1 line
2.31.1
PATCH 2/8 docs: trace: coresight: coresight-etm4x-reference.rst: replace some characters
In reply to Mauro Carvalho ChehabThe 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
--- Documentation/trace/coresight/coresight-etm4x-reference.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/trace/coresight/coresight-etm4x-reference.rst +1 -1
@@ -427,7 +427,7 @@ the ‘TRC’ prefix. :Syntax: ``echo idx > vmid_idx`` - Where idx < numvmidc + Where idx < numvmidc ----
Signature · 1 line
2.31.1
PATCH 3/8 docs: driver-api: ioctl.rst: replace some characters
In reply to Mauro Carvalho ChehabThe 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
--- Documentation/driver-api/ioctl.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/driver-api/ioctl.rst +4 -4
@@ -25,9 +25,9 @@ ioctl commands that follow modern conventions: ``_IO``, ``_IOR``, with the correct parameters: _IO/_IOR/_IOW/_IOWR - The macro name specifies how the argument will be used. It may be a + The macro name specifies how the argument will be used. It may be a pointer to data to be passed into the kernel (_IOW), out of the kernel - (_IOR), or both (_IOWR). _IO can indicate either commands with no + (_IOR), or both (_IOWR). _IO can indicate either commands with no argument or those passing an integer value instead of a pointer. It is recommended to only use _IO for commands without arguments, and use pointers for passing data.
@@ -200,10 +200,10 @@ cause an information leak, which can be used to defeat kernel address space layout randomization (KASLR), helping in an attack. For this reason (and for compat support) it is best to avoid any -implicit padding in data structures. Where there is implicit padding +implicit padding in data structures. Where there is implicit padding in an existing structure, kernel drivers must be careful to fully initialize an instance of the structure before copying it to user -space. This is usually done by calling memset() before assigning to +space. This is usually done by calling memset() before assigning to individual members. Subsystem abstractions
Signature · 1 line
2.31.1
PATCH 4/8 docs: usb: replace some characters
In reply to Mauro Carvalho ChehabThe 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+feff (''): BOM
as it is not needed on UTF-8
--- Documentation/usb/ehci.rst | 2 +- Documentation/usb/gadget_printer.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/usb/ehci.rst +1 -1
@@ -1,4 +1,4 @@ -=========== +=========== EHCI driver ===========
Documentation/usb/gadget_printer.rst +1 -1
@@ -1,4 +1,4 @@ -=============================== +=============================== Linux USB Printer Gadget Driver ===============================
Signature · 1 line
2.31.1
Re: [PATCH 4/8] docs: usb: replace some characters
Quoted 7 lines · Mauro Carvalho Chehab
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:
Quoted 8 lines
- U+feff (''): BOM
as it is not needed on UTF-8Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/usb/ehci.rst | 2 +- Documentation/usb/gadget_printer.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
PATCH 5/8 docs: vm: zswap.rst: replace some characters
In reply to Mauro Carvalho ChehabThe 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
--- Documentation/vm/zswap.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/vm/zswap.rst +2 -2
@@ -10,7 +10,7 @@ Overview Zswap is a lightweight compressed cache for swap pages. It takes pages that are in the process of being swapped out and attempts to compress them into a dynamically allocated RAM-based memory pool. zswap basically trades CPU cycles -for potentially reduced swap I/O. This trade-off can also result in a +for potentially reduced swap I/O. This trade-off can also result in a significant performance improvement if reads from the compressed cache are faster than reads from a swap device.
@@ -26,7 +26,7 @@ faster than reads from a swap device. performance impact of swapping. * Overcommitted guests that share a common I/O resource can dramatically reduce their swap I/O pressure, avoiding heavy handed I/O - throttling by the hypervisor. This allows more work to get done with less + throttling by the hypervisor. This allows more work to get done with less impact to the guest workload and guests sharing the I/O subsystem * Users with SSDs as swap devices can extend the life of the device by drastically reducing life-shortening writes.
Signature · 1 line
2.31.1
PATCH 6/8 docs: filesystems: ext4: blockgroup.rst: replace some characters
In reply to Mauro Carvalho ChehabThe 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+2217 ('∗'): ASTERISK OPERATOR
use ASCII asterisk instead of the ASTERISK OPERATOR
--- Documentation/filesystems/ext4/blockgroup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/filesystems/ext4/blockgroup.rst +1 -1
@@ -84,7 +84,7 @@ Without the option META\_BG, for safety concerns, all block group descriptors copies are kept in the first block group. Given the default 128MiB(2^27 bytes) block group size and 64-byte group descriptors, ext4 can have at most 2^27/64 = 2^21 block groups. This limits the entire -filesystem size to 2^21 ∗ 2^27 = 2^48bytes or 256TiB. +filesystem size to 2^21 * 2^27 = 2^48bytes or 256TiB. The solution to this problem is to use the metablock group feature (META\_BG), which is already in ext3 for all 2.6 releases. With the
Signature · 1 line
2.31.1
Re: [PATCH 6/8] docs: filesystems: ext4: blockgroup.rst: replace some characters
Quoted 11 lines · Mauro Carvalho Chehab
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+2217 ('∗'): ASTERISK OPERATOR
use ASCII asterisk instead of the ASTERISK OPERATORSigned-off-by Mauro Carvalho Chehab <[email protected]>
- Ted
PATCH 7/8 docs: networking: device_drivers: replace some characters
In reply to Mauro Carvalho ChehabThe 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
--- .../networking/device_drivers/ethernet/intel/i40e.rst | 6 +++--- .../networking/device_drivers/ethernet/intel/iavf.rst | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-)
Documentation/networking/device_drivers/ethernet/intel/i40e.rst +3 -3
@@ -466,7 +466,7 @@ network. PTP support varies among Intel devices that support this driver. Use "ethtool -T <netdev name>" to get a definitive list of PTP capabilities supported by the device. -IEEE 802.1ad (QinQ)?Support +IEEE 802.1ad (QinQ) Support --------------------------- The IEEE 802.1ad standard, informally known as QinQ, allows for multiple VLAN IDs within a single Ethernet frame. VLAN IDs are sometimes referred to as
@@ -523,8 +523,8 @@ of a port's bandwidth (should it be available). The sum of all the values for Maximum Bandwidth is not restricted, because no more than 100% of a port's bandwidth can ever be used. -NOTE:?X710/XXV710 devices fail to enable Max VFs (64) when Multiple Functions -per Port (MFP)?and SR-IOV are enabled. An error from i40e is logged that says +NOTE: X710/XXV710 devices fail to enable Max VFs (64) when Multiple Functions +per Port (MFP) and SR-IOV are enabled. An error from i40e is logged that says "add vsi failed for VF N, aq_err 16". To workaround the issue, enable less than 64 virtual functions (VFs).
Documentation/networking/device_drivers/ethernet/intel/iavf.rst +1 -1
@@ -113,7 +113,7 @@ which the AVF is associated. The following are base mode features: - AVF device ID - HW mailbox is used for VF to PF communications (including on Windows) -IEEE 802.1ad (QinQ)?Support +IEEE 802.1ad (QinQ) Support --------------------------- The IEEE 802.1ad standard, informally known as QinQ, allows for multiple VLAN IDs within a single Ethernet frame. VLAN IDs are sometimes referred to as
Signature · 1 line
2.31.1
PATCH 8/8 docs: PCI: Replace non-breaking spaces to avoid PDF issues
In reply to Mauro Carvalho ChehabThe 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
--- Documentation/PCI/acpi-info.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)
Documentation/PCI/acpi-info.rst +9 -9
@@ -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.
Signature · 1 line
2.31.1
Quoted 9 lines · Mauro Carvalho Chehab
Hi Jon,
This series contain the remaining 8 patches I submitted at v3 that weren't merged yet at -next.
This series is rebased on the top of your docs-next branch.
No changes here, except by some Reviewed/ack lines, and at the name of the final patch (per PCI maintainer's request).
Applied, thanks.
jon