[libvirt] [PATCH] docs: correct improper information about domain states in virsh manpage

Laine Stump posted 1 patch 6 years, 10 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20170606161259.21315-1-laine@laine.org
tools/virsh.pod | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
[libvirt] [PATCH] docs: correct improper information about domain states in virsh manpage
Posted by Laine Stump 6 years, 10 months ago
Commit 24d4a0a1f removed the non-existent "dying" state from the list
of possible domain states given in the virsh manpage, but didn't
correct the count of states from 8 down to 7. This patch fixes that
mismatch, while wording the sentence in a more readable/truthful
manner.
---
 tools/virsh.pod | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index aee9646..611ea88 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -418,8 +418,9 @@ State is the run state (see below).
 
 B<STATES>
 
-The State field lists 8 states for a domain, and which ones the
-current domain is in.
+The State field lists what state each domain is currently in. A domain
+can be in one of the following seven possible states:
+
 
 =over 4
 
-- 
2.9.3

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH] docs: correct improper information about domain states in virsh manpage
Posted by Andrea Bolognani 6 years, 10 months ago
On Tue, 2017-06-06 at 12:12 -0400, Laine Stump wrote:
> Commit 24d4a0a1f removed the non-existent "dying" state from the list
> of possible domain states given in the virsh manpage, but didn't
> correct the count of states from 8 down to 7. This patch fixes that
> mismatch, while wording the sentence in a more readable/truthful
> manner.
> ---
>  tools/virsh.pod | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/virsh.pod b/tools/virsh.pod
> index aee9646..611ea88 100644
> --- a/tools/virsh.pod
> +++ b/tools/virsh.pod
> @@ -418,8 +418,9 @@ State is the run state (see below).
>  
>  B<STATES>
>  
> -The State field lists 8 states for a domain, and which ones the
> -current domain is in.
> +The State field lists what state each domain is currently in. A domain
> +can be in one of the following seven possible states:
> +
>  
>  =over 4
>  

Why don't we get rid of the number altogether while we're
at it, so that we don't risk the sentence being off sync
with the list ever again? :)

Whether or not you decide to drop the number:

Reviewed-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization

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