libvhost-user: improve vu_queue_pop() doc
authorMarc-André Lureau <marcandre.lureau@redhat.com>
Thu, 10 Aug 2017 23:25:38 +0000 (01:25 +0200)
committerMarc-André Lureau <marcandre.lureau@redhat.com>
Tue, 10 Oct 2017 21:31:08 +0000 (23:31 +0200)
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
contrib/libvhost-user/libvhost-user.h

index 4021f1124eea19b9a9e2b87f18764eae83516d6f..5825b66880bdb135d06d5b543093d7ec5cdc64ca 100644 (file)
@@ -358,7 +358,8 @@ void vu_queue_notify(VuDev *dev, VuVirtq *vq);
  * @vq: a VuVirtq queue
  * @sz: the size of struct to return (must be >= VuVirtqElement)
  *
- * Returns: a VuVirtqElement filled from the queue or NULL.
+ * Returns: a VuVirtqElement filled from the queue or NULL. The
+ * returned element must be free()-d by the caller.
  */
 void *vu_queue_pop(VuDev *dev, VuVirtq *vq, size_t sz);