[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]

Re: [libvirt] [PATCH] man pages: adjusted virsh help command to show updated options



On 12/03/2010 10:23 AM, Justin Clift wrote:
> Updated to reflect that the optional --command parameter can
> be given, as well as either a command name or group keyword.
> ---
>  tools/virsh.pod |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
> 
> diff --git a/tools/virsh.pod b/tools/virsh.pod
> index 9cb6829..a8f2912 100644
> --- a/tools/virsh.pod
> +++ b/tools/virsh.pod
> @@ -115,7 +115,7 @@ The following commands are generic i.e. not specific to a domain.
>  
>  =over 4
>  
> -=item B<help> optional I<command-or-group>
> +=item B<help> optional I<--command> I<command-or-group-keyword>

NACK.  We already have the practice of omitting the I<--command>
argument for a command where the string is recognized purely by position
(where the --option is optional).  For example, look at 'virsh suspend',
where <domain> is required (that is, where 'suspend --domain xyz' is
equivalent to 'suspend xyz'):

=item B<suspend> I<domain-id>

Note that the virsh.pod is spelled domain-id, even though the optional
option is only spelled --domain, so we already have precedence for using
a longer, more-descriptive string in the man page than what you get for
'virsh help suspend'.

I don't think we need to make any further tweaks to virsh.pod for this
issue.

-- 
Eric Blake   eblake redhat com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

Attachment: signature.asc
Description: OpenPGP digital signature


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]