linux-kernel - Re: [PATCH] KVM: Documentation: rectify rst markup in kvm

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: <3461a412-f214-fb75-3b82-97466aca03f4@redhat.com>
Date:   Fri, 26 Feb 2021 09:03:21 +0100
From:   Paolo Bonzini <pbonzini@...hat.com>
To:     Chenyi Qiang <chenyi.qiang@...el.com>
Cc:     Stephen Rothwell <sfr@...b.auug.org.au>,
        Jonathan Corbet <corbet@....net>, kvm@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] KVM: Documentation: rectify rst markup in kvm_run->flags

On 26/02/21 08:55, Chenyi Qiang wrote:
> Commit c32b1b896d2a ("KVM: X86: Add the Document for
> KVM_CAP_X86_BUS_LOCK_EXIT") added a new flag in kvm_run->flags
> documentation, and caused warning in make htmldocs:
> 
>    Documentation/virt/kvm/api.rst:5004: WARNING: Unexpected indentation
>    Documentation/virt/kvm/api.rst:5004: WARNING: Inline emphasis start-string without end-string
> 
> Fix this rst markup issue.
> 
> Signed-off-by: Chenyi Qiang <chenyi.qiang@...el.com>
> ---
>   Documentation/virt/kvm/api.rst | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index aed52b0fc16e..0717bf523034 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -5000,7 +5000,8 @@ local APIC is not used.
>   	__u16 flags;
>   
>   More architecture-specific flags detailing state of the VCPU that may
> -affect the device's behavior. Current defined flags:
> +affect the device's behavior. Current defined flags::
> +
>     /* x86, set if the VCPU is in system management mode */
>     #define KVM_RUN_X86_SMM     (1 << 0)
>     /* x86, set if bus lock detected in VM */
> 

Queued, thanks.

Paolo