2021-02-26 07:55:24

by Chenyi Qiang

Subject: [PATCH] KVM: Documentation: rectify rst markup in kvm_run->flags

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 <[email protected]>
---
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 */
--
2.17.1

2021-02-26 08:07:20

by Paolo Bonzini

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 <[email protected]>
> ---
> 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