[libvirt] [PATCH] clarify vmrsh net commands

[Eric Blake]

On 03/16/2013 11:36 AM, Gene Czarcinski wrote:

s/vmrsh/virsh/ in the subject

> Clarify that net-create deals with a transient virtual
> network whereas net-define defines a persistent virtual
> network definition and will create the network (xml)
> definition file.
> 
> Clarify that net-destroy works with both transient and
> persistent virtual networks

These parts are fine.

.
> 
> Change the comment about error checking with respect to
> net-edit and net-define: same error checking and
> diagnostics.

Actually, net-edit does MORE error checking than net-define - it also
checks whether the network object has been redefined in the middle, and
allows an opportunity to retry.  I'd rather keep this part of the man
page similar to the text used in other *-edit commands.

> +++ b/tools/virsh.pod
> @@ -2034,19 +2034,20 @@ The I<--disable> option disable autostarting.
>  
>  =item B<net-create> I<file>
>  
> -Create a virtual network from an XML I<file>, see the documentation at
> -L<http://libvirt.org/formatnetwork.html> to get a description of the
> -XML network format used by libvirt.
> +Create a transient (temporary) virtual network from an
> +XML I<file> and instantiate (start) the network.
> +See the documentation at L<http://libvirt.org/formatnetwork.html>
> +to get a description of the XML network format used by libvirt.
>  
>  =item B<net-define> I<file>
>  
> -Define a virtual network from an XML I<file>, the network is just defined but
> -not instantiated.
> +Define a persistent virtual network from an XML I<file>, the network is just defined but

This line is now longer than 80 columns.

> +not instantiated (started).
>  
>  =item B<net-destroy> I<network>
>  
> -Destroy (stop) a given virtual network specified by its name or UUID. This
> -takes effect immediately.
> +Destroy (stop) a given transient or persistent virtual network
> +specified by its name or UUID. This takes effect immediately.
>  
>  =item B<net-dumpxml> I<network> [I<--inactive>]
>  
> @@ -2064,7 +2065,8 @@ This is equivalent to:
>   vi network.xml (or make changes with your other text editor)
>   virsh net-define network.xml
>  
> -except that it does some error checking.
> +The same error checking is performed by net-edit and net-define and
> +the same diagnostic error messages will be issued.

This is the one hunk I omitted.

ACK with that change, and pushed.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 621 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20130320/e4ff53dc/attachment-0001.sig>