From: Gene Czarcinski <gene@czarc.net>
Date: Sat, 16 Mar 2013 17:36:32 +0000 (-0400)
Subject: clarify virsh net commands
X-Git-Tag: v1.0.4-rc1~48
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2e1cd8900f28a23ccad6d9fa054d686cdc36384a;p=thirdparty%2Flibvirt.git

clarify virsh net commands

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.

Signed-off-by: Gene Czarcinski <gene@czarc.net>
---

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 7fb89e41ee..b5e632e9ea 100644
--- a/tools/virsh.pod
+++ 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 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>]