Skip to contentSkip to conversation

Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

PATCH Applied Bagas Sanjaya 2 participants 7 messages Jun 27, 2022 – Aug 13, 2022

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

cover Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

After merging kvm tree for linux-next, Stephen Rothwell reported htmldocs warnings on KVM_CAP_VM_DISABLE_NX_HUGE_PAGES capability documentation:

Documentation/virt/kvm/api.rst:8210: WARNING: Title underline too short.

8.38 KVM_CAP_VM_DISABLE_NX_HUGE_PAGES
---------------------------
Documentation/virt/kvm/api.rst:8217: WARNING: Unexpected indentation.

Fix these warnings by:

[1/2]: extend the heading underline
[2/2]: properly format the capability table

Cc Paolo Bonzini <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc David Matlack <[email protected]>
Cc Ben Gardon <[email protected]>
Cc Peter Xu <[email protected]>

Bagas Sanjaya (2):
Documentation: KVM: extend KVM_CAP_VM_DISABLE_NX_HUGE_PAGES heading
underline
KVM: x86/MMU: properly format KVM_CAP_VM_DISABLE_NX_HUGE_PAGES
capability table

 Documentation/virt/kvm/api.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

PATCH 1/2 Documentation: KVM: extend KVM_CAP_VM_DISABLE_NX_HUGE_PAGES heading underline

Extend heading underline for KVM_CAP_VM_DISABLE_NX_HUGE_PAGE to match the heading text length.

Fixes 084cc29f8bbb03 ("KVM: x86/MMU: Allow NX huge pages to be disabled on a per-vm basis")
Cc Paolo Bonzini <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc David Matlack <[email protected]>
Cc Ben Gardon <[email protected]>
Cc Peter Xu <[email protected]>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
index bafaeedd455c38..ec9f16f472e709 100644
@@ -8207,7 +8207,7 @@ dump related UV data. Also the vcpu ioctl `KVM_S390_PV_CPU_COMMAND` is
 available and supports the `KVM_PV_DUMP_CPU` subcommand.
 
 8.38 KVM_CAP_VM_DISABLE_NX_HUGE_PAGES
----------------------------
+-------------------------------------
 
 :Capability KVM_CAP_VM_DISABLE_NX_HUGE_PAGES
 :Architectures: x86
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw

PATCH 2/2 KVM: x86/MMU: properly format KVM_CAP_VM_DISABLE_NX_HUGE_PAGES capability table

In reply to Bagas Sanjaya

There is unexpected warning on KVM_CAP_VM_DISABLE_NX_HUGE_PAGES capability table, which cause the table to be rendered as paragraph text instead.

The warning is due to missing colon at capability name and returns keyword, as well as improper alignment on multi-line returns field.

Fix the warning by adding missing colons and aligning the field.

Fixes 084cc29f8bbb03 ("KVM: x86/MMU: Allow NX huge pages to be disabled on a per-vm basis")
Cc Paolo Bonzini <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc David Matlack <[email protected]>
Cc Ben Gardon <[email protected]>
Cc Peter Xu <[email protected]>
---
 Documentation/virt/kvm/api.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/virt/kvm/api.rst +4 -4
index ec9f16f472e709..df8fc905217437 100644
@@ -8209,13 +8209,13 @@ available and supports the `KVM_PV_DUMP_CPU` subcommand.
 8.38 KVM_CAP_VM_DISABLE_NX_HUGE_PAGES
 -------------------------------------
 
-:Capability KVM_CAP_VM_DISABLE_NX_HUGE_PAGES
+:Capability: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES
 :Architectures: x86
 :Type: vm
 :Parameters: arg[0] must be 0.
-:Returns 0 on success, -EPERM if the userspace process does not
-	 have CAP_SYS_BOOT, -EINVAL if args[0] is not 0 or any vCPUs have been
-	 created.
+:Returns: 0 on success, -EPERM if the userspace process does not
+          have CAP_SYS_BOOT, -EINVAL if args[0] is not 0 or any vCPUs have been
+          created.
 
 This capability disables the NX huge pages mitigation for iTLB MULTIHIT.
 
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#4 lore raw
Quoted 5 lines · Paolo Bonzini

Queued, thanks.

Paolo

Thanks for picking this up. However, Stephen noted that the issue is already showed up on mainline [1]. Maybe this series should be queued for 6.0 release (as -rc fixes), right?

[1]: https://lore.kernel.org/linux-next/[email protected]/

Signature · 1 line
An old man doll... just what I always wanted! - Clara
maintainer
#5 lore raw
Quoted 10 lines · Bagas Sanjaya
Quoted 5 lines · Paolo Bonzini

Queued, thanks.

Paolo

Thanks for picking this up. However, Stephen noted that the issue is already showed up on mainline [1]. Maybe this series should be queued for 6.0 release (as -rc fixes), right?

Yes, it's in Linus's tree already. Thanks for replying to Stephen.

Paolo

#6 lore raw
Quoted 7 lines · Paolo Bonzini
Quoted 4 lines

Thanks for picking this up. However, Stephen noted that the issue is already showed up on mainline [1]. Maybe this series should be queued for 6.0 release (as -rc fixes), right?

Yes, it's in Linus's tree already.  Thanks for replying to Stephen.

Thanks.

Signature · 1 line
An old man doll... just what I always wanted! - Clara