Skip to contentSkip to conversation

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

PATCH Applied Chenyi Qiang 2 participants 2 messages Feb 26, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

---
 Documentation/virt/kvm/api.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +2 -1
index aed52b0fc16e..0717bf523034 100644
@@ -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 */
Signature · 1 line
2.17.1
maintainer Applied
#1 lore raw
Quoted 20 lines · Chenyi Qiang

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.

---
  Documentation/virt/kvm/api.rst | 3 ++-
  1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +0 -0
index aed52b0fc16e..0717bf523034 100644

Documentation/virt/kvm/api.rst local APIC is not used. · line 5007

Quoted 9 lines
Documentation/virt/kvm/api.rst +2 -1
@@ -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