lkml.org 
[lkml]   [2021]   [May]   [12]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 39/40] docs: virt: kvm: api.rst: Use ASCII subset instead of UTF-8 alternate symbols
    Date
    The conversion tools used during DocBook/LaTeX/Markdown->ReST conversion
    and some automatic rules which exists on certain text editors like
    LibreOffice turned ASCII characters into some UTF-8 alternatives that
    are better displayed on html and PDF.

    While it is OK to use UTF-8 characters in Linux, it is better to
    use the ASCII subset instead of using an UTF-8 equivalent character
    as it makes life easier for tools like grep, and are easier to edit
    with the some commonly used text/source code editors.

    Also, Sphinx already do such conversion automatically outside literal blocks:
    https://docutils.sourceforge.io/docs/user/smartquotes.html

    So, replace the occurences of the following UTF-8 characters:

    - U+00a0 (' '): NO-BREAK SPACE

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    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 22d077562149..295daf6178f8 100644
    --- a/Documentation/virt/kvm/api.rst
    +++ b/Documentation/virt/kvm/api.rst
    @@ -850,7 +850,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:
    @@ -2144,10 +2144,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
    @@ -2585,10 +2585,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
    @@ -3107,13 +3107,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:
    @@ -3234,8 +3234,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).
    ===== ==============================================================

    ::
    @@ -3283,7 +3283,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.30.2
    \
     
     \ /
      Last update: 2021-05-12 14:54    [W:4.200 / U:0.032 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site