iface-define: update and unify documentation

Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1127045

Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
This commit is contained in:
Pavel Hrdina 2015-02-25 15:37:00 +01:00
parent 367363659b
commit 0632555927
3 changed files with 9 additions and 7 deletions

View File

@ -1,7 +1,7 @@
/*
* libvirt-interface.c: entry points for virInterfacePtr APIs
*
* Copyright (C) 2006-2014 Red Hat, Inc.
* Copyright (C) 2006-2015 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@ -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

View File

@ -1,7 +1,7 @@
/*
* virsh-interface.c: Commands to manage host interface
*
* Copyright (C) 2005, 2007-2014 Red Hat, Inc.
* Copyright (C) 2005, 2007-2015 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
@ -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}
};

View File

@ -2861,8 +2861,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>