* [PATCH] doc: kvm: fix return description of KVM_SET_MSRS
@ 2019-09-02 10:12 Xiaoyao Li
2019-09-03 16:33 ` Sean Christopherson
0 siblings, 1 reply; 3+ messages in thread
From: Xiaoyao Li @ 2019-09-02 10:12 UTC (permalink / raw)
To: Paolo Bonzini, Radim Krčmář
Cc: Xiaoyao Li, Jonathan Corbet, kvm, linux-doc, linux-kernel
Signed-off-by: Xiaoyao Li <xiaoyao.li@intel.com>
---
Documentation/virt/kvm/api.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/virt/kvm/api.txt b/Documentation/virt/kvm/api.txt
index 2d067767b617..a2efc19e0f4e 100644
--- a/Documentation/virt/kvm/api.txt
+++ b/Documentation/virt/kvm/api.txt
@@ -586,7 +586,7 @@ Capability: basic
Architectures: x86
Type: vcpu ioctl
Parameters: struct kvm_msrs (in)
-Returns: 0 on success, -1 on error
+Returns: number of msrs successfully set, -1 on error
Writes model-specific registers to the vcpu. See KVM_GET_MSRS for the
data structures.
--
2.19.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] doc: kvm: fix return description of KVM_SET_MSRS
2019-09-02 10:12 [PATCH] doc: kvm: fix return description of KVM_SET_MSRS Xiaoyao Li
@ 2019-09-03 16:33 ` Sean Christopherson
2019-09-04 6:04 ` Xiaoyao Li
0 siblings, 1 reply; 3+ messages in thread
From: Sean Christopherson @ 2019-09-03 16:33 UTC (permalink / raw)
To: Xiaoyao Li
Cc: Paolo Bonzini, Radim Krčmář,
Jonathan Corbet, kvm, linux-doc, linux-kernel
On Mon, Sep 02, 2019 at 06:12:14PM +0800, Xiaoyao Li wrote:
It may seem silly, but a proper changelog would be helpful even here,
e.g. to explain how and when a positive return value can diverge from the
number of MSRs specific in struct kvm_msrs.
> Signed-off-by: Xiaoyao Li <xiaoyao.li@intel.com>
> ---
> Documentation/virt/kvm/api.txt | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/virt/kvm/api.txt b/Documentation/virt/kvm/api.txt
> index 2d067767b617..a2efc19e0f4e 100644
> --- a/Documentation/virt/kvm/api.txt
> +++ b/Documentation/virt/kvm/api.txt
> @@ -586,7 +586,7 @@ Capability: basic
> Architectures: x86
> Type: vcpu ioctl
> Parameters: struct kvm_msrs (in)
> -Returns: 0 on success, -1 on error
> +Returns: number of msrs successfully set, -1 on error
Similar to the changelong comment, it'd be helpful to elaborate on the
positive return value, e.g.:
Returns: number of msrs successfully set (see below), -1 on error
and then something in the free form text explaining how the ioctl stops
processing MSRs if setting an MSR fails.
> Writes model-specific registers to the vcpu. See KVM_GET_MSRS for the
> data structures.
> --
> 2.19.1
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] doc: kvm: fix return description of KVM_SET_MSRS
2019-09-03 16:33 ` Sean Christopherson
@ 2019-09-04 6:04 ` Xiaoyao Li
0 siblings, 0 replies; 3+ messages in thread
From: Xiaoyao Li @ 2019-09-04 6:04 UTC (permalink / raw)
To: Sean Christopherson
Cc: Paolo Bonzini, Radim Krčmář,
Jonathan Corbet, kvm, linux-doc, linux-kernel
On 9/4/2019 12:33 AM, Sean Christopherson wrote:
> On Mon, Sep 02, 2019 at 06:12:14PM +0800, Xiaoyao Li wrote:
>
> It may seem silly, but a proper changelog would be helpful even here,
> e.g. to explain how and when a positive return value can diverge from the
> number of MSRs specific in struct kvm_msrs.
>
>> Signed-off-by: Xiaoyao Li <xiaoyao.li@intel.com>
>> ---
>> Documentation/virt/kvm/api.txt | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/virt/kvm/api.txt b/Documentation/virt/kvm/api.txt
>> index 2d067767b617..a2efc19e0f4e 100644
>> --- a/Documentation/virt/kvm/api.txt
>> +++ b/Documentation/virt/kvm/api.txt
>> @@ -586,7 +586,7 @@ Capability: basic
>> Architectures: x86
>> Type: vcpu ioctl
>> Parameters: struct kvm_msrs (in)
>> -Returns: 0 on success, -1 on error
>> +Returns: number of msrs successfully set, -1 on error
>
> Similar to the changelong comment, it'd be helpful to elaborate on the
> positive return value, e.g.:
>
> Returns: number of msrs successfully set (see below), -1 on error
>
> and then something in the free form text explaining how the ioctl stops
> processing MSRs if setting an MSR fails.
>
Do it in v2, thanks!
>> Writes model-specific registers to the vcpu. See KVM_GET_MSRS for the
>> data structures.
>> --
>> 2.19.1
>>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-09-04 6:04 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-09-02 10:12 [PATCH] doc: kvm: fix return description of KVM_SET_MSRS Xiaoyao Li
2019-09-03 16:33 ` Sean Christopherson
2019-09-04 6:04 ` Xiaoyao Li
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).