[v4] docs: kvm: x86: Fix broken field list

Message ID 20230404101401.25012-1-itazur@amazon.com
State New
Headers
Series [v4] docs: kvm: x86: Fix broken field list |

Commit Message

Takahiro Itazuri April 4, 2023, 10:14 a.m. UTC
  Add missing ":" to fix a broken field list.

Fixes: ba7bb663f554 ("KVM: x86: Provide per VM capability for disabling PMU virtualization")
Reported-by: kernel test robot <lkp@intel.com>
Link: https://lore.kernel.org/oe-kbuild-all/202304041708.siWlxmyD-lkp@intel.com/
Signed-off-by: Takahiro Itazuri <itazur@amazon.com>
---
v3 -> v4
* Add "Reported-by:" tag.
* Link to v3: https://lore.kernel.org/all/20230404090052.9872-1-itazur@amazon.com/

v2 -> v3
* Add another missing ":"
* Link to v2: https://lore.kernel.org/all/20230331093116.99820-1-itazur@amazon.com/

v1 -> v2
* Fix commit message to say "Do foo" instead of "This commit does foo".
* Add "Fixes:" tag.
* Link to v1: https://lore.kernel.org/all/20230330233956.78246-1-itazur@amazon.com/

 Documentation/virt/kvm/api.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Comments

Jonathan Corbet April 10, 2023, 10:39 p.m. UTC | #1
Takahiro Itazuri <itazur@amazon.com> writes:

> Add missing ":" to fix a broken field list.
>
> Fixes: ba7bb663f554 ("KVM: x86: Provide per VM capability for disabling PMU virtualization")
> Reported-by: kernel test robot <lkp@intel.com>
> Link: https://lore.kernel.org/oe-kbuild-all/202304041708.siWlxmyD-lkp@intel.com/
> Signed-off-by: Takahiro Itazuri <itazur@amazon.com>
> ---
> v3 -> v4
> * Add "Reported-by:" tag.
> * Link to v3: https://lore.kernel.org/all/20230404090052.9872-1-itazur@amazon.com/
>
> v2 -> v3
> * Add another missing ":"
> * Link to v2: https://lore.kernel.org/all/20230331093116.99820-1-itazur@amazon.com/
>
> v1 -> v2
> * Fix commit message to say "Do foo" instead of "This commit does foo".
> * Add "Fixes:" tag.
> * Link to v1: https://lore.kernel.org/all/20230330233956.78246-1-itazur@amazon.com/
>
>  Documentation/virt/kvm/api.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 62de0768d6aa..a5c803f39832 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -8296,11 +8296,11 @@ ENOSYS for the others.
>  8.35 KVM_CAP_PMU_CAPABILITY
>  ---------------------------
>  
> -:Capability KVM_CAP_PMU_CAPABILITY
> +:Capability: KVM_CAP_PMU_CAPABILITY
>  :Architectures: x86
>  :Type: vm
>  :Parameters: arg[0] is bitmask of PMU virtualization capabilities.
> -:Returns 0 on success, -EINVAL when arg[0] contains invalid bits
> +:Returns: 0 on success, -EINVAL when arg[0] contains invalid bits

Applied, thanks.

jon
  

Patch

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 62de0768d6aa..a5c803f39832 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -8296,11 +8296,11 @@  ENOSYS for the others.
 8.35 KVM_CAP_PMU_CAPABILITY
 ---------------------------
 
-:Capability KVM_CAP_PMU_CAPABILITY
+:Capability: KVM_CAP_PMU_CAPABILITY
 :Architectures: x86
 :Type: vm
 :Parameters: arg[0] is bitmask of PMU virtualization capabilities.
-:Returns 0 on success, -EINVAL when arg[0] contains invalid bits
+:Returns: 0 on success, -EINVAL when arg[0] contains invalid bits
 
 This capability alters PMU virtualization in KVM.