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>
This commit is contained in:
Dan Kenigsberg 2018-08-22 08:43:32 +03:00 committed by Erik Skultety
parent 9a4e4b942d
commit d88a87d6c4

View File

@ -1125,9 +1125,10 @@ virStoragePoolGetAutostart(virStoragePoolPtr pool,
/** /**
* virStoragePoolSetAutostart: * virStoragePoolSetAutostart:
* @pool: pointer to storage pool * @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 * Returns 0 on success, -1 on failure
*/ */