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
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.
Em Mon, 17 May 2021 11:48:04 +0100
David Woodhouse <[email protected]> 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 <[email protected]>
Thanks,
Mauro