[libvirt] [PATCH 1/1] Add note about numeric domain names to manpage
Clarify that domains with numeric names can only be identified by their domain id. --- tools/virsh.pod | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index 2120429..e30f1b6 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -26,12 +26,16 @@ The basic structure of most virsh usage is: virsh [OPTION]... <command> <domain> [ARG]... -Where I<command> is one of the commands listed below, I<domain> is the numeric -domain id, or the domain name, or the domain UUID and I<ARGS> are command -specific options. There are a few exceptions to this rule in the cases where -the command in question acts on all domains, the entire machine, or directly -on the xen hypervisor. Those exceptions will be clear for each of those -commands. +Where I<command> is one of the commands listed below, I<domain> is the +numeric domain id, or the domain name, or the domain UUID and I<ARGS> +are command specific options. There are a few exceptions to this rule +in the cases where the command in question acts on all domains, the +entire machine, or directly on the xen hypervisor. Those exceptions +will be clear for each of those commands. Note: it is permissible to +give numeric names to domains, however, doing so will result in a +domain that can only be identified by domain id. In other words, if a +numeric value is supplied it will be interpreted as a domain id, not +as a name. The B<virsh> program can be used either to run one I<COMMAND> by giving the command and its arguments on the shell command line, or a I<COMMAND_STRING> -- 1.7.11.4
On 10/01/2012 12:01 PM, Dave Allan wrote:
Clarify that domains with numeric names can only be identified by their domain id. --- tools/virsh.pod | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/tools/virsh.pod b/tools/virsh.pod index 2120429..e30f1b6 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -26,12 +26,16 @@ The basic structure of most virsh usage is:
virsh [OPTION]... <command> <domain> [ARG]...
-Where I<command> is one of the commands listed below, I<domain> is the numeric -domain id, or the domain name, or the domain UUID and I<ARGS> are command -specific options. There are a few exceptions to this rule in the cases where -the command in question acts on all domains, the entire machine, or directly -on the xen hypervisor. Those exceptions will be clear for each of those -commands. +Where I<command> is one of the commands listed below, I<domain> is the +numeric domain id, or the domain name, or the domain UUID and I<ARGS>
pre-existing, but while we are touching this, I think adding a semicolon after UUID makes the sentence flow better, to separate the list of alternative domain spellings from the rest of the sentence, rather than squashing ARGS into the third spelling option.
+are command specific options. There are a few exceptions to this rule +in the cases where the command in question acts on all domains, the +entire machine, or directly on the xen hypervisor. Those exceptions +will be clear for each of those commands. Note: it is permissible to +give numeric names to domains, however, doing so will result in a +domain that can only be identified by domain id. In other words, if a +numeric value is supplied it will be interpreted as a domain id, not +as a name.
ACK. -- Eric Blake eblake@redhat.com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
participants (2)
-
Dave Allan -
Eric Blake