[PATCH next 0/2] Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

[PATCH next 0/2] Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

[Bagas Sanjaya]

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 <pbonzini@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: David Matlack <dmatlack@google.com>
Cc: Ben Gardon <bgardon@google.com>
Cc: Peter Xu <peterx@redhat.com>
Cc: kvm@vger.kernel.org
Cc: linux-next@vger.kernel.org
Cc: linux-kernel@vger.kernel.org

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(-)

-- 
An old man doll... just what I always wanted! - Clara

[PATCH next 1/2] Documentation: KVM: extend KVM_CAP_VM_DISABLE_NX_HUGE_PAGES heading underline

[Bagas Sanjaya]

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

Link: https://lore.kernel.org/lkml/20220627181937.3be67263@canb.auug.org.au/
Fixes: 084cc29f8bbb03 ("KVM: x86/MMU: Allow NX huge pages to be disabled on a per-vm basis")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: David Matlack <dmatlack@google.com>
Cc: Ben Gardon <bgardon@google.com>
Cc: Peter Xu <peterx@redhat.com>
Cc: kvm@vger.kernel.org
Cc: linux-next@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index bafaeedd455c38..ec9f16f472e709 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -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
-- 
An old man doll... just what I always wanted! - Clara

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

[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.

Link: https://lore.kernel.org/lkml/20220627181937.3be67263@canb.auug.org.au/
Fixes: 084cc29f8bbb03 ("KVM: x86/MMU: Allow NX huge pages to be disabled on a per-vm basis")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: David Matlack <dmatlack@google.com>
Cc: Ben Gardon <bgardon@google.com>
Cc: Peter Xu <peterx@redhat.com>
Cc: kvm@vger.kernel.org
Cc: linux-next@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/virt/kvm/api.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index ec9f16f472e709..df8fc905217437 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -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.
 
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH next 0/2] Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

[Paolo Bonzini]

Queued, thanks.

Paolo

Re: [PATCH next 0/2] Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

[Bagas Sanjaya]

On 8/11/22 13:36, Paolo Bonzini wrote:
> 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/20220809164147.131f87d0@canb.auug.org.au/

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH next 0/2] Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

[Paolo Bonzini]

On 8/11/22 15:30, Bagas Sanjaya wrote:
> On 8/11/22 13:36, Paolo Bonzini wrote:
>> 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

Re: [PATCH next 0/2] Documentation: KVM: KVM_CAP_VM_DISABLE_NX_HUGE_PAGES documentation fixes

[Bagas Sanjaya]

On 8/12/22 14:40, Paolo Bonzini wrote:
>>
>> 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.

-- 
An old man doll... just what I always wanted! - Clara