[libvirt] [PATCH 3/3] net-define: update or unify documentation
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1127045
Signed-off-by: Pavel Hrdina <phrdina(a)redhat.com>
---
src/libvirt-network.c | 3 ++-
tools/virsh-network.c | 5 +++--
tools/virsh.pod | 4 ++--
3 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/src/libvirt-network.c b/src/libvirt-network.c
index 8769c79..4225ffb 100644
--- a/src/libvirt-network.c
+++ b/src/libvirt-network.c
@@ -433,7 +433,8 @@ virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc)
* @conn: pointer to the hypervisor connection
* @xml: the XML description for the network, preferably in UTF-8
*
- * Define a network, but does not create it
+ * Define an inactive persistent virtual network or modify an existing
+ * persistent one from the XML description.
*
* virNetworkFree should be used to free the resources after the
* network object is no longer needed.
diff --git a/tools/virsh-network.c b/tools/virsh-network.c
index 5f8743c..b0360b7 100644
--- a/tools/virsh-network.c
+++ b/tools/virsh-network.c
@@ -189,10 +189,11 @@ cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
*/
static const vshCmdInfo info_network_define[] = {
{.name = "help",
- .data = N_("define (but don't start) a network from an XML file")
+ .data = N_("define an inactive persistent virtual network or modify "
+ "an existing persistent one from an XML file")
},
{.name = "desc",
- .data = N_("Define a network.")
+ .data = N_("Define or modify a persistent virtual network.")
},
{.name = NULL}
};
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 780f75b..698f64b 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -2675,8 +2675,8 @@ to get a description of the XML network format used by libvirt.
=item B<net-define> I<file>
-Define a persistent virtual network from an XML I<file>, the network is just
-defined but not instantiated (started).
+Define an inactive persistent virtual network or modify an existing persistent
+one from the XML I<file>.
=item B<net-destroy> I<network>
--
2.0.5