doc: better explanation for virStoragePoolSetAutostart

[libvirt] [PATCH] doc: better explanation for virStoragePoolSetAutostart

Dan Kenigsberg posted 1 patch 5 years, 8 months ago

Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20180822054329.GA12901@redhat.com

Test syntax-check passed

src/libvirt-storage.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

Expand all Fold all

[libvirt] [PATCH] doc: better explanation for virStoragePoolSetAutostart

Posted by Dan Kenigsberg 5 years, 8 months ago

The former documentation was an unhelpful tautology. The suggested doc
mimicks^Wcopies the one of virDomainSetAutostart.

Signed-off-by: Dan Kenigsberg <danken@redhat.com>
---
 src/libvirt-storage.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c
index 1879c6bd60..ed305b9b5e 100644
--- a/src/libvirt-storage.c
+++ b/src/libvirt-storage.c
@@ -1127,7 +1127,8 @@ virStoragePoolGetAutostart(virStoragePoolPtr pool,
  * @pool: pointer to storage pool
  * @autostart: new flag setting
  *
- * Sets the autostart flag
+ * Configure the storage pool to be automatically started
+ * when the host machine boots.
  *
  * Returns 0 on success, -1 on failure
  */
-- 
2.17.1

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] doc: better explanation for virStoragePoolSetAutostart

Posted by Erik Skultety 5 years, 8 months ago

On Wed, Aug 22, 2018 at 08:43:32AM +0300, Dan Kenigsberg wrote:
> The former documentation was an unhelpful tautology. The suggested doc
> mimicks^Wcopies the one of virDomainSetAutostart.
>
> Signed-off-by: Dan Kenigsberg <danken@redhat.com>
> ---
>  src/libvirt-storage.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c
> index 1879c6bd60..ed305b9b5e 100644
> --- a/src/libvirt-storage.c
> +++ b/src/libvirt-storage.c
> @@ -1127,7 +1127,8 @@ virStoragePoolGetAutostart(virStoragePoolPtr pool,
>   * @pool: pointer to storage pool
>   * @autostart: new flag setting
>   *
> - * Sets the autostart flag
> + * Configure the storage pool to be automatically started
> + * when the host machine boots.

I rewrote the commit message a tiny bit and also changed the description of
@autostart argument to be consistent with the other uses too.

Reviewed-by: Erik Skultety <eskultet@redhat.com>

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list