Re: [PATCH] doc: kvm: fix return description of KVM_SET_MSRS

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxx>
---
  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




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux