From: Sean Christopherson <sean.j.christopherson@intel.com>
To: Xiaoyao Li <xiaoyao.li@intel.com>
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
"Radim Krčmář" <rkrcmar@redhat.com>,
"Jonathan Corbet" <corbet@lwn.net>,
kvm@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] doc: kvm: fix return description of KVM_SET_MSRS
Date: Tue, 3 Sep 2019 09:33:32 -0700 [thread overview]
Message-ID: <20190903163332.GF10768@linux.intel.com> (raw)
In-Reply-To: <20190902101214.77833-1-xiaoyao.li@intel.com>
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
>
next prev parent reply other threads:[~2019-09-03 16:33 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-02 10:12 [PATCH] doc: kvm: fix return description of KVM_SET_MSRS Xiaoyao Li
2019-09-03 16:33 ` Sean Christopherson [this message]
2019-09-04 6:04 ` Xiaoyao Li
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190903163332.GF10768@linux.intel.com \
--to=sean.j.christopherson@intel.com \
--cc=corbet@lwn.net \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pbonzini@redhat.com \
--cc=rkrcmar@redhat.com \
--cc=xiaoyao.li@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).