Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes
Subsystems (3)
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
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
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.
--- Documentation/virt/kvm/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
@@ -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
PATCH 2/2 KVM: x86/MMU: properly format KVM_CAP_VM_DISABLE_NX_HUGE_PAGES capability table
In reply to Bagas SanjayaThere 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.
--- Documentation/virt/kvm/api.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/virt/kvm/api.rst +4 -4
@@ -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
Queued, thanks.
Paolo
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
Paolo Bonzini
maintainerQuoted 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
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