]> www.infradead.org Git - users/hch/block.git/commitdiff
KVM: fix documentation for KVM_CREATE_GUEST_MEMFD
authorCarlos López <clopez@suse.de>
Wed, 24 Apr 2024 10:33:16 +0000 (12:33 +0200)
committerSean Christopherson <seanjc@google.com>
Fri, 3 May 2024 22:11:23 +0000 (15:11 -0700)
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>
Fixes: a7800aa80ea4 ("KVM: Add KVM_CREATE_GUEST_MEMFD ioctl() for guest-specific backing memory")
Link: https://lore.kernel.org/r/20240424103317.28522-1-clopez@suse.de
Signed-off-by: Sean Christopherson <seanjc@google.com>
Documentation/virt/kvm/api.rst

index 0b5a33ee71eea11e5dabe09ad77e62426a72fd11..57bd2b2b1532d4f76ad0e2181ecd698772cddc17 100644 (file)
@@ -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