Skip to contentSkip to conversation

Get rid of some undesirable characters

PATCH Applied Mauro Carvalho Chehab 4 participants 7 messages Jul 22, 2021 – Jul 26, 2021

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

cover Get rid of some undesirable characters

Hi Jon,

While rebasing my docs tree, I noticed that there are three remaining patches from my past series that replace some UTF-8 chars by ASCII ones that aren't applied yet. Not sure what happened here.

Anyway, those are the missing ones.

Mauro Carvalho Chehab (3):
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

 .../firmware-guide/acpi/dsd/graph.rst         |  2 +-
 .../kernel-api/writing-an-alsa-driver.rst     |  2 +-
 Documentation/virt/kvm/api.rst                | 28 +++++++++----------
 3 files changed, 16 insertions(+), 16 deletions(-)
Signature · 1 line
2.31.1
#1 lore raw

PATCH 1/3 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

---
 Documentation/sound/kernel-api/writing-an-alsa-driver.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/sound/kernel-api/writing-an-alsa-driver.rst +1 -1
index 255b7d3bebd6..176b73583b7a 100644
@@ -3368,7 +3368,7 @@ This ensures that the device can be closed and the driver unloaded
 without losing data.
 
 This callback is optional. If you do not set ``drain`` in the struct
-snd_rawmidi_ops structure, ALSA will simply wait for 50 milliseconds
+snd_rawmidi_ops structure, ALSA will simply wait for 50 milliseconds
 instead.
 
 Miscellaneous Devices
Signature · 1 line
2.31.1
#2 lore raw

PATCH 2/3 docs: firmware-guide: acpi: dsd: graph.rst: replace some characters

In reply to 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+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output

---
 Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/firmware-guide/acpi/dsd/graph.rst +1 -1
index 4341299aa937..0ced07cb1be3 100644
@@ -159,7 +159,7 @@ References
 
 [2] Devicetree. https://www.devicetree.org, referenced 2016-10-03.
 
-[3] Documentation/devicetree/bindings/graph.txt
+[3] Documentation/devicetree/bindings/graph.txt
 
 [4] Device Properties UUID For _DSD.
     https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf,
Signature · 1 line
2.31.1
#3 lore raw

Re: [PATCH 2/3] docs: firmware-guide: acpi: dsd: graph.rst: replace some characters

Hi Mauro,

Quoted 21 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+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output

---
 Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/firmware-guide/acpi/dsd/graph.rst +0 -0
index 4341299aa937..0ced07cb1be3 100644

Documentation/firmware-guide/acpi/dsd/graph.rst References · line 162

Quoted 5 lines
Documentation/firmware-guide/acpi/dsd/graph.rst +1 -1
@@ -159,7 +159,7 @@ References
 
 [2] Devicetree. https://www.devicetree.org, referenced 2016-10-03.
 
-[3] Documentation/devicetree/bindings/graph.txt
+[3] Documentation/devicetree/bindings/graph.txt

I probably wrote this as a non-break space is produced by space + mod5, preceded by opening bracket which also requires mod5.

The file is there but the file has moved to DT schema repository. I believe the correct reference is:

https://github.com/devicetree-org/dt-schema/blob/master/schemas/graph.yaml

Quoted 3 lines
Documentation/firmware-guide/acpi/dsd/graph.rst +0 -0
 [4] Device Properties UUID For _DSD.
     https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf,
Signature · 3 lines
Kind regards,

Sakari Ailus
#4 lore raw

PATCH 3/3 docs: virt: kvm: api.rst: replace some characters

In reply to 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+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output

---
 Documentation/virt/kvm/api.rst | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)
Documentation/virt/kvm/api.rst +14 -14
index c7b165ca70b6..3a6118540747 100644
@@ -855,7 +855,7 @@ in-kernel irqchip (GIC), and for in-kernel irqchip can tell the GIC to
 use PPIs designated for specific cpus.  The irq field is interpreted
 like this::
 
-  bits:  |  31 ... 28  | 27 ... 24 | 23  ... 16 | 15 ... 0 |
+  bits:  |  31 ... 28  | 27 ... 24 | 23  ... 16 | 15 ... 0 |
   field: | vcpu2_index | irq_type  | vcpu_index |  irq_id  |
 
 The irq_type field has the following values:
@@ -2149,10 +2149,10 @@ prior to calling the KVM_RUN ioctl.
 Errors:
 
   ======   ============================================================
-  ENOENT   no such register
-  EINVAL   invalid register ID, or no such register or used with VMs in
+  ENOENT   no such register
+  EINVAL   invalid register ID, or no such register or used with VMs in
            protected virtualization mode on s390
-  EPERM    (arm64) register access not allowed before vcpu finalization
+  EPERM    (arm64) register access not allowed before vcpu finalization
   ======   ============================================================
 
 (These error codes are indicative only: do not rely on a specific error
@@ -2590,10 +2590,10 @@ following id bit patterns::
 Errors include:
 
   ======== ============================================================
-  ENOENT   no such register
-  EINVAL   invalid register ID, or no such register or used with VMs in
+  ENOENT   no such register
+  EINVAL   invalid register ID, or no such register or used with VMs in
            protected virtualization mode on s390
-  EPERM    (arm64) register access not allowed before vcpu finalization
+  EPERM    (arm64) register access not allowed before vcpu finalization
   ======== ============================================================
 
 (These error codes are indicative only: do not rely on a specific error
@@ -3112,13 +3112,13 @@ current state.  "addr" is ignored.
 Errors:
 
   ======     =================================================================
-  EINVAL     the target is unknown, or the combination of features is invalid.
-  ENOENT     a features bit specified is unknown.
+  EINVAL     the target is unknown, or the combination of features is invalid.
+  ENOENT     a features bit specified is unknown.
   ======     =================================================================
 
 This tells KVM what type of CPU to present to the guest, and what
-optional features it should have.  This will cause a reset of the cpu
-registers to their initial values.  If this is not called, KVM_RUN will
+optional features it should have.  This will cause a reset of the cpu
+registers to their initial values.  If this is not called, KVM_RUN will
 return ENOEXEC for that vcpu.
 
 The initial values are defined as:
@@ -3239,8 +3239,8 @@ VCPU matching underlying host.
 Errors:
 
   =====      ==============================================================
-  E2BIG      the reg index list is too big to fit in the array specified by
-             the user (the number required will be written into n).
+  E2BIG      the reg index list is too big to fit in the array specified by
+             the user (the number required will be written into n).
   =====      ==============================================================
 
 ::
@@ -3288,7 +3288,7 @@ specific device.
 ARM/arm64 divides the id field into two parts, a device id and an
 address type id specific to the individual device::
 
-  bits:  | 63        ...       32 | 31    ...    16 | 15    ...    0 |
+  bits:  | 63        ...       32 | 31    ...    16 | 15    ...    0 |
   field: |        0x00000000      |     device id   |  addr type id  |
 
 ARM/arm64 currently only require this when using the in-kernel GIC
Signature · 1 line
2.31.1
maintainer Applied
#5 lore raw

Re: [PATCH 3/3] docs: virt: kvm: api.rst: 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 7 lines

- U+00a0 (' '): NO-BREAK SPACE
as it can cause lines being truncated on PDF output

---
  Documentation/virt/kvm/api.rst | 28 ++++++++++++++--------------
  1 file changed, 14 insertions(+), 14 deletions(-)

Queued, thanks.

Paolo

Quoted 80 lines
Documentation/virt/kvm/api.rst +14 -14
index c7b165ca70b6..3a6118540747 100644
@@ -855,7 +855,7 @@ in-kernel irqchip (GIC), and for in-kernel irqchip can tell the GIC to
  use PPIs designated for specific cpus.  The irq field is interpreted
  like this::
 
-  bits:  |  31 ... 28  | 27 ... 24 | 23  ... 16 | 15 ... 0 |
+  bits:  |  31 ... 28  | 27 ... 24 | 23  ... 16 | 15 ... 0 |
    field: | vcpu2_index | irq_type  | vcpu_index |  irq_id  |
 
  The irq_type field has the following values:
@@ -2149,10 +2149,10 @@ prior to calling the KVM_RUN ioctl.
  Errors:
 
    ======   ============================================================
-  ENOENT   no such register
-  EINVAL   invalid register ID, or no such register or used with VMs in
+  ENOENT   no such register
+  EINVAL   invalid register ID, or no such register or used with VMs in
             protected virtualization mode on s390
-  EPERM    (arm64) register access not allowed before vcpu finalization
+  EPERM    (arm64) register access not allowed before vcpu finalization
    ======   ============================================================
 
  (These error codes are indicative only: do not rely on a specific error
@@ -2590,10 +2590,10 @@ following id bit patterns::
  Errors include:
 
    ======== ============================================================
-  ENOENT   no such register
-  EINVAL   invalid register ID, or no such register or used with VMs in
+  ENOENT   no such register
+  EINVAL   invalid register ID, or no such register or used with VMs in
             protected virtualization mode on s390
-  EPERM    (arm64) register access not allowed before vcpu finalization
+  EPERM    (arm64) register access not allowed before vcpu finalization
    ======== ============================================================
 
  (These error codes are indicative only: do not rely on a specific error
@@ -3112,13 +3112,13 @@ current state.  "addr" is ignored.
  Errors:
 
    ======     =================================================================
-  EINVAL     the target is unknown, or the combination of features is invalid.
-  ENOENT     a features bit specified is unknown.
+  EINVAL     the target is unknown, or the combination of features is invalid.
+  ENOENT     a features bit specified is unknown.
    ======     =================================================================
 
  This tells KVM what type of CPU to present to the guest, and what
-optional features it should have.  This will cause a reset of the cpu
-registers to their initial values.  If this is not called, KVM_RUN will
+optional features it should have.  This will cause a reset of the cpu
+registers to their initial values.  If this is not called, KVM_RUN will
  return ENOEXEC for that vcpu.
 
  The initial values are defined as:
@@ -3239,8 +3239,8 @@ VCPU matching underlying host.
  Errors:
 
    =====      ==============================================================
-  E2BIG      the reg index list is too big to fit in the array specified by
-             the user (the number required will be written into n).
+  E2BIG      the reg index list is too big to fit in the array specified by
+             the user (the number required will be written into n).
    =====      ==============================================================
 
  ::
@@ -3288,7 +3288,7 @@ specific device.
  ARM/arm64 divides the id field into two parts, a device id and an
  address type id specific to the individual device::
 
-  bits:  | 63        ...       32 | 31    ...    16 | 15    ...    0 |
+  bits:  | 63        ...       32 | 31    ...    16 | 15    ...    0 |
    field: |        0x00000000      |     device id   |  addr type id  |
 
  ARM/arm64 currently only require this when using the in-kernel GIC
maintainer Applied
#6 lore raw
In reply to Mauro Carvalho Chehab
Quoted 14 lines · Mauro Carvalho Chehab

Hi Jon,

While rebasing my docs tree, I noticed that there are three remaining patches from my past series that replace some UTF-8 chars by ASCII ones that aren't applied yet. Not sure what happened here.

Anyway, those are the missing ones.

Mauro Carvalho Chehab (3):
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

Quoted 4 lines
 .../firmware-guide/acpi/dsd/graph.rst         |  2 +-
 .../kernel-api/writing-an-alsa-driver.rst     |  2 +-
 Documentation/virt/kvm/api.rst                | 28 +++++++++----------
 3 files changed, 16 insertions(+), 16 deletions(-)

Applied, thanks.

jon