src: storage: Provide a better explanation of virStoragePoolSetAutostart

The former documentation was an unhelpful tautology. The suggested doc
borrows the wording from virDomainSetAutostart.

Signed-off-by: Dan Kenigsberg <danken@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>

diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c
index 1879c6bd60330c273bb2bc6116cfb00b3d014cb8..2ea3e94e4527bdc108728af22409b8f5fa06d398 100644 (file)
--- a/src/libvirt-storage.c
+++ b/src/libvirt-storage.c
@@ -1125,9 +1125,10 @@ virStoragePoolGetAutostart(virStoragePoolPtr pool,
 /**
  * virStoragePoolSetAutostart:
  * @pool: pointer to storage pool
- * @autostart: new flag setting
+ * @autostart: whether the storage pool should be automatically started 0 or 1
  *
- * Sets the autostart flag
+ * Configure the storage pool to be automatically started
+ * when the host machine boots.
  *
  * Returns 0 on success, -1 on failure
  */