diff mbox series

KVM: Documentation: Fix spec for KVM_CAP_ENABLE_CAP_VM

Message ID 20210108165349.747359-1-qperret@google.com (mailing list archive)
State New, archived
Headers show
Series KVM: Documentation: Fix spec for KVM_CAP_ENABLE_CAP_VM | expand

Commit Message

Quentin Perret Jan. 8, 2021, 4:53 p.m. UTC
The documentation classifies KVM_ENABLE_CAP with KVM_CAP_ENABLE_CAP_VM
as a vcpu ioctl, which is incorrect. Fix it by specifying it as a VM
ioctl.

Fixes: e5d83c74a580 ("kvm: make KVM_CAP_ENABLE_CAP_VM architecture agnostic")
Signed-off-by: Quentin Perret <qperret@google.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Quentin Perret Jan. 15, 2021, 1:49 p.m. UTC | #1
On Friday 08 Jan 2021 at 16:53:49 (+0000), Quentin Perret wrote:
> The documentation classifies KVM_ENABLE_CAP with KVM_CAP_ENABLE_CAP_VM
> as a vcpu ioctl, which is incorrect. Fix it by specifying it as a VM
> ioctl.

Anything I should do on this one?

Thanks,
Quentin
Will Deacon Jan. 15, 2021, 4:50 p.m. UTC | #2
On Fri, Jan 08, 2021 at 04:53:49PM +0000, Quentin Perret wrote:
> The documentation classifies KVM_ENABLE_CAP with KVM_CAP_ENABLE_CAP_VM
> as a vcpu ioctl, which is incorrect. Fix it by specifying it as a VM
> ioctl.
> 
> Fixes: e5d83c74a580 ("kvm: make KVM_CAP_ENABLE_CAP_VM architecture agnostic")
> Signed-off-by: Quentin Perret <qperret@google.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 70254eaa5229..68898b623d86 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -1328,7 +1328,7 @@ documentation when it pops into existence).
>  
>  :Capability: KVM_CAP_ENABLE_CAP_VM
>  :Architectures: all
> -:Type: vcpu ioctl
> +:Type: vm ioctl
>  :Parameters: struct kvm_enable_cap (in)
>  :Returns: 0 on success; -1 on error

I tripped over this as well, so:

Acked-by: Will Deacon <will@kernel.org>

Will
Sean Christopherson Jan. 15, 2021, 10:31 p.m. UTC | #3
On Fri, Jan 15, 2021, Will Deacon wrote:
> On Fri, Jan 08, 2021 at 04:53:49PM +0000, Quentin Perret wrote:
> > The documentation classifies KVM_ENABLE_CAP with KVM_CAP_ENABLE_CAP_VM
> > as a vcpu ioctl, which is incorrect. Fix it by specifying it as a VM
> > ioctl.

On a related topic, x86 should report KVM_CAP_ENABLE_CAP as supported, it's had
a vCPU version since commit 5c919412fe61 ("kvm/x86: Hyper-V synthetic interrupt
controller").  I'll send a patch.

> > Fixes: e5d83c74a580 ("kvm: make KVM_CAP_ENABLE_CAP_VM architecture agnostic")
> > Signed-off-by: Quentin Perret <qperret@google.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 70254eaa5229..68898b623d86 100644
> > --- a/Documentation/virt/kvm/api.rst
> > +++ b/Documentation/virt/kvm/api.rst
> > @@ -1328,7 +1328,7 @@ documentation when it pops into existence).
> >  
> >  :Capability: KVM_CAP_ENABLE_CAP_VM
> >  :Architectures: all
> > -:Type: vcpu ioctl
> > +:Type: vm ioctl
> >  :Parameters: struct kvm_enable_cap (in)
> >  :Returns: 0 on success; -1 on error
> 
> I tripped over this as well, so:
> 
> Acked-by: Will Deacon <will@kernel.org>

The problem is that you read the documentation.  Who does that?

Reviewed-by: Sean Christopherson <seanjc@google.com>
Paolo Bonzini Jan. 18, 2021, 5:38 p.m. UTC | #4
On 15/01/21 17:50, Will Deacon wrote:
> On Fri, Jan 08, 2021 at 04:53:49PM +0000, Quentin Perret wrote:
>> The documentation classifies KVM_ENABLE_CAP with KVM_CAP_ENABLE_CAP_VM
>> as a vcpu ioctl, which is incorrect. Fix it by specifying it as a VM
>> ioctl.
>>
>> Fixes: e5d83c74a580 ("kvm: make KVM_CAP_ENABLE_CAP_VM architecture agnostic")
>> Signed-off-by: Quentin Perret <qperret@google.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 70254eaa5229..68898b623d86 100644
>> --- a/Documentation/virt/kvm/api.rst
>> +++ b/Documentation/virt/kvm/api.rst
>> @@ -1328,7 +1328,7 @@ documentation when it pops into existence).
>>   
>>   :Capability: KVM_CAP_ENABLE_CAP_VM
>>   :Architectures: all
>> -:Type: vcpu ioctl
>> +:Type: vm ioctl
>>   :Parameters: struct kvm_enable_cap (in)
>>   :Returns: 0 on success; -1 on error
> 
> I tripped over this as well, so:
> 
> Acked-by: Will Deacon <will@kernel.org>
> 
> Will
> 

Queued, thanks.

Paolo
diff mbox series

Patch

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 70254eaa5229..68898b623d86 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -1328,7 +1328,7 @@  documentation when it pops into existence).
 
 :Capability: KVM_CAP_ENABLE_CAP_VM
 :Architectures: all
-:Type: vcpu ioctl
+:Type: vm ioctl
 :Parameters: struct kvm_enable_cap (in)
 :Returns: 0 on success; -1 on error