[libvirt] [PATCH 0/3] update and unify some documentation texts
Pavel Hrdina (3): iface-define: update and unify documentation pool-define: update and unify documentation net-define: update or unify documentation src/libvirt-interface.c | 3 ++- src/libvirt-network.c | 3 ++- src/libvirt-storage.c | 4 ++-- tools/virsh-interface.c | 5 +++-- tools/virsh-network.c | 5 +++-- tools/virsh-pool.c | 5 +++-- tools/virsh.pod | 11 ++++++----- 7 files changed, 21 insertions(+), 15 deletions(-) -- 2.0.5
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1127045 Signed-off-by: Pavel Hrdina <phrdina@redhat.com> --- src/libvirt-interface.c | 3 ++- tools/virsh-interface.c | 5 +++-- tools/virsh.pod | 4 ++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/libvirt-interface.c b/src/libvirt-interface.c index 815a41a..4bdb3a8 100644 --- a/src/libvirt-interface.c +++ b/src/libvirt-interface.c @@ -443,7 +443,8 @@ virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags) * @xml: the XML description for the interface, preferably in UTF-8 * @flags: extra flags; not used yet, so callers should always pass 0 * - * Define an interface (or modify existing interface configuration). + * Define an inactive persistent physical host interface or modify an existing + * persistent one from the XML description. * * Normally this change in the interface configuration is immediately * permanent/persistent, but if virInterfaceChangeBegin() has been diff --git a/tools/virsh-interface.c b/tools/virsh-interface.c index 5f848b6..57966b5 100644 --- a/tools/virsh-interface.c +++ b/tools/virsh-interface.c @@ -507,10 +507,11 @@ cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd) */ static const vshCmdInfo info_interface_define[] = { {.name = "help", - .data = N_("define (but don't start) a physical host interface from an XML file") + .data = N_("define an inactive persistent physical host interface or " + "modify an existing persistent one from an XML file") }, {.name = "desc", - .data = N_("Define a physical host interface.") + .data = N_("Define or modify a persistent physical host interface.") }, {.name = NULL} }; diff --git a/tools/virsh.pod b/tools/virsh.pod index 343f26f..6e65dfb 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -2835,8 +2835,8 @@ See also B<iface-unbridge> for undoing this operation. =item B<iface-define> I<file> -Define a host interface from an XML I<file>, the interface is just defined but -not started. +Define an inactive persistent physical host interface or modify an existing +persistent one from the XML I<file>. =item B<iface-destroy> I<interface> -- 2.0.5
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1127045 Signed-off-by: Pavel Hrdina <phrdina@redhat.com> --- src/libvirt-storage.c | 4 ++-- tools/virsh-pool.c | 5 +++-- tools/virsh.pod | 3 ++- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c index 54c7332..704597d 100644 --- a/src/libvirt-storage.c +++ b/src/libvirt-storage.c @@ -551,8 +551,8 @@ virStoragePoolCreateXML(virConnectPtr conn, * @xml: XML description for new pool * @flags: extra flags; not used yet, so callers should always pass 0 * - * Define a new inactive storage pool based on its XML description. The - * pool is persistent, until explicitly undefined. + * Define an inactive persistent storage pool or modify an existing persistent + * one from the XML description. * * virStoragePoolFree should be used to free the resources after the * storage pool object is no longer needed. diff --git a/tools/virsh-pool.c b/tools/virsh-pool.c index addbccc..f93a0bc 100644 --- a/tools/virsh-pool.c +++ b/tools/virsh-pool.c @@ -397,10 +397,11 @@ cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd) */ static const vshCmdInfo info_pool_define[] = { {.name = "help", - .data = N_("define (but don't start) a pool from an XML file") + .data = N_("define an inactive persistent storage pool or modify " + "an existing persistent one from an XML file") }, {.name = "desc", - .data = N_("Define a pool.") + .data = N_("Define or modify a persistent storage pool.") }, {.name = NULL} }; diff --git a/tools/virsh.pod b/tools/virsh.pod index 6e65dfb..780f75b 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -3030,7 +3030,8 @@ the vHBA. =item B<pool-define> I<file> -Create, but do not start, a pool object from the XML I<file>. +Define an inactive persistent storage pool or modify an existing persistent one +from the XML I<file>. =item B<pool-define-as> I<name> I<type> [I<--print-xml>] [I<--source-host hostname>] [I<--source-path path>] [I<--source-dev path>] -- 2.0.5
Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1127045 Signed-off-by: Pavel Hrdina <phrdina@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
On 02/25/2015 10:40 AM, Pavel Hrdina wrote:
Pavel Hrdina (3): iface-define: update and unify documentation pool-define: update and unify documentation net-define: update or unify documentation
src/libvirt-interface.c | 3 ++- src/libvirt-network.c | 3 ++- src/libvirt-storage.c | 4 ++-- tools/virsh-interface.c | 5 +++-- tools/virsh-network.c | 5 +++-- tools/virsh-pool.c | 5 +++-- tools/virsh.pod | 11 ++++++----- 7 files changed, 21 insertions(+), 15 deletions(-)
ACK series... One note though that we probably should get better at - updating copyright dates... All are consistent - although not part of the bz - I took a peek at a 'define' (domain), secret-define, and nwfilter-define and it seems those too could use similar tweaks for look-n-feel... John
On Fri, Mar 06, 2015 at 04:47:22PM -0500, John Ferlan wrote:
On 02/25/2015 10:40 AM, Pavel Hrdina wrote:
Pavel Hrdina (3): iface-define: update and unify documentation pool-define: update and unify documentation net-define: update or unify documentation
src/libvirt-interface.c | 3 ++- src/libvirt-network.c | 3 ++- src/libvirt-storage.c | 4 ++-- tools/virsh-interface.c | 5 +++-- tools/virsh-network.c | 5 +++-- tools/virsh-pool.c | 5 +++-- tools/virsh.pod | 11 ++++++----- 7 files changed, 21 insertions(+), 15 deletions(-)
ACK series... One note though that we probably should get better at - updating copyright dates...
All are consistent - although not part of the bz - I took a peek at a 'define' (domain), secret-define, and nwfilter-define and it seems those too could use similar tweaks for look-n-feel...
John
Thanks for review. And good point about the copyrights, I should definitely get better at updating them. Pushed now with copyrights properly updated. Pavel
participants (2)
-
John Ferlan -
Pavel Hrdina