vhost_task: fix vhost_task_create() documentation
authorStefano Garzarella <sgarzare@redhat.com>
Thu, 27 Mar 2025 12:44:35 +0000 (13:44 +0100)
committerMichael S. Tsirkin <mst@redhat.com>
Fri, 18 Apr 2025 14:08:11 +0000 (10:08 -0400)
Commit cb380909ae3b ("vhost: return task creation error instead of NULL")
changed the return value of vhost_task_create(), but did not update the
documentation.

Reflect the change in the documentation: on an error, vhost_task_create()
returns an ERR_PTR() and no longer NULL.

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
Message-Id: <20250327124435.142831-1-sgarzare@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
kernel/vhost_task.c

index 2ef2e1b8009165d05d96935737204706dbdedbd1..2f844c279a3e01fd0fb75a09f8845f9e17dff86d 100644 (file)
@@ -111,7 +111,7 @@ EXPORT_SYMBOL_GPL(vhost_task_stop);
  * @arg: data to be passed to fn and handled_kill
  * @name: the thread's name
  *
- * This returns a specialized task for use by the vhost layer or NULL on
+ * This returns a specialized task for use by the vhost layer or ERR_PTR() on
  * failure. The returned task is inactive, and the caller must fire it up
  * through vhost_task_start().
  */