[libvirt] [PATCH] clarify vmrsh 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.
Change the comment about error checking with respect to
net-edit and net-define: same error checking and
diagnostics.
Signed-off-by: Gene Czarcinski <gene(a)czarc.net>
---
tools/virsh.pod | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/tools/virsh.pod b/tools/virsh.pod
index a5d8fe6..1fe08f4 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>]
@@ -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.
The editor used can be supplied by the C<$VISUAL> or C<$EDITOR> environment
variables, and defaults to C<vi>.
--
1.8.1.4