qdev: Document qdev_prop_set_drive_err() return value
authorPhilippe Mathieu-Daudé <f4bug@amsat.org>
Mon, 20 Jul 2020 12:16:59 +0000 (14:16 +0200)
committerEduardo Habkost <ehabkost@redhat.com>
Wed, 19 Aug 2020 14:44:29 +0000 (10:44 -0400)
Since commit 73ac1aac39 qdev_prop_set_drive_err() returns
a boolean value. Document it.

Fixes: 73ac1aac39 "Make functions taking Error ** return bool, not void"
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Message-Id: <20200720121659.31886-1-f4bug@amsat.org>
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
include/hw/qdev-properties.h

index 8f3a98cba698b274ef1e799174f34a0c7ef49af1..528310bb22ffb5dc688e9869f87be36cda9f5819 100644 (file)
@@ -238,6 +238,8 @@ extern const PropertyInfo qdev_prop_pcie_link_width;
 
 /*
  * Set properties between creation and realization.
+ *
+ * Returns: %true on success, %false on error.
  */
 bool qdev_prop_set_drive_err(DeviceState *dev, const char *name,
                              BlockBackend *value, Error **errp);