linux-kernel - Re: [PATCH 3/3] docs: virt: kvm: api.rst: replace some characters

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <33d0dd04-15ba-9d32-c73f-9d086cd3e458@redhat.com>
Date:   Mon, 26 Jul 2021 14:26:18 +0200
From:   Paolo Bonzini <pbonzini@...hat.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>
Cc:     kvm@...r.kernel.org, linux-kernel@...r.kernel.org
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 <mchehab+huawei@...nel.org>
> ---
>   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
>