Message ID | 20240424103317.28522-1-clopez@suse.de (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | KVM: fix documentation for KVM_CREATE_GUEST_MEMFD | expand |
On Wed, Apr 24, 2024, Carlos López wrote: > The KVM_CREATE_GUEST_MEMFD ioctl returns a file descriptor, and is > documented as such in the description. However, the "Returns" field > in the documentation states that the ioctl returns 0 on success. > Update this to match the description. > > Signed-off-by: Carlos López <clopez@suse.de> Ugh, copy+paste fail. Good job me. In case want this backported, Fixes: a7800aa80ea4 ("KVM: Add KVM_CREATE_GUEST_MEMFD ioctl() for guest-specific backing memory") Reviewed-by: Sean Christopherson <seanjc@google.com>
On Wed, 24 Apr 2024 12:33:16 +0200, Carlos López wrote: > The KVM_CREATE_GUEST_MEMFD ioctl returns a file descriptor, and is > documented as such in the description. However, the "Returns" field > in the documentation states that the ioctl returns 0 on success. > Update this to match the description. > > Applied to kvm-x86 generic, thanks! [1/1] KVM: fix documentation for KVM_CREATE_GUEST_MEMFD https://github.com/kvm-x86/linux/commit/2098acaf2445 -- https://github.com/kvm-x86/linux/tree/next
diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst index 0b5a33ee71ee..57bd2b2b1532 100644 --- a/Documentation/virt/kvm/api.rst +++ b/Documentation/virt/kvm/api.rst @@ -6316,7 +6316,7 @@ The "flags" field is reserved for future extensions and must be '0'. :Architectures: none :Type: vm ioctl :Parameters: struct kvm_create_guest_memfd(in) -:Returns: 0 on success, <0 on error +:Returns: A file descriptor on success, <0 on error KVM_CREATE_GUEST_MEMFD creates an anonymous file and returns a file descriptor that refers to it. guest_memfd files are roughly analogous to files created
The KVM_CREATE_GUEST_MEMFD ioctl returns a file descriptor, and is documented as such in the description. However, the "Returns" field in the documentation states that the ioctl returns 0 on success. Update this to match the description. Signed-off-by: Carlos López <clopez@suse.de> --- Documentation/virt/kvm/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)