2021-07-22 09:51:14

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 0/3] 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(-)

--
2.31.1



2021-07-22 09:51:20

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 3/3] docs: virt: kvm: api.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]>
---
Documentation/virt/kvm/api.rst | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index c7b165ca70b6..3a6118540747 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -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
--
2.31.1

2021-07-22 09:51:34

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [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

Reviewed-by: Takashi Iwai <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/sound/kernel-api/writing-an-alsa-driver.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst
index 255b7d3bebd6..176b73583b7a 100644
--- a/Documentation/sound/kernel-api/writing-an-alsa-driver.rst
+++ b/Documentation/sound/kernel-api/writing-an-alsa-driver.rst
@@ -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
--
2.31.1

2021-07-22 09:54:32

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 2/3] docs: firmware-guide: acpi: dsd: graph.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

Acked-by: Rafael J. Wysocki <[email protected]>
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst
index 4341299aa937..0ced07cb1be3 100644
--- a/Documentation/firmware-guide/acpi/dsd/graph.rst
+++ b/Documentation/firmware-guide/acpi/dsd/graph.rst
@@ -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,
--
2.31.1

2021-07-25 20:37:45

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH 0/3] Get rid of some undesirable characters

Mauro Carvalho Chehab <[email protected]> writes:

> 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(-)

Applied, thanks.

jon

2021-07-26 12:06:10

by Sakari Ailus

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

Hi Mauro,

On Thu, Jul 22, 2021 at 11:50:02AM +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
>
> Acked-by: Rafael J. Wysocki <[email protected]>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst
> index 4341299aa937..0ced07cb1be3 100644
> --- a/Documentation/firmware-guide/acpi/dsd/graph.rst
> +++ b/Documentation/firmware-guide/acpi/dsd/graph.rst
> @@ -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

>
> [4] Device Properties UUID For _DSD.
> https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf,

--
Kind regards,

Sakari Ailus

2021-07-26 12:30:10

by Paolo Bonzini

[permalink] [raw]
Subject: Re: [PATCH 3/3] docs: virt: kvm: api.rst: replace some characters

On 22/07/21 11:50, 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 <[email protected]>
> ---
> Documentation/virt/kvm/api.rst | 28 ++++++++++++++--------------
> 1 file changed, 14 insertions(+), 14 deletions(-)

Queued, thanks.

Paolo

> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index c7b165ca70b6..3a6118540747 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -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
>