diff mbox series

KVM: Documentation: rectify rst markup in kvm_run->flags

Message ID 20210226075541.27179-1-chenyi.qiang@intel.com (mailing list archive)
State New, archived
Headers show
Series KVM: Documentation: rectify rst markup in kvm_run->flags | expand

Commit Message

Chenyi Qiang Feb. 26, 2021, 7:55 a.m. UTC
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@intel.com>
---
 Documentation/virt/kvm/api.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Paolo Bonzini Feb. 26, 2021, 8:03 a.m. UTC | #1
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@intel.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
diff mbox series

Patch

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 */