openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Consistent spacing in *GetXMLDesc functions 

We copy-and-paste a lot of our docs, as evidenced by the number of
*GetXMLDesc() functions which had the same unusual indentation and
missing capital in the second sentence of the returns paragraph.

Signed-off-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Eric Blake 2019-03-13 14:42:30 -05:00
parent f2cb0c8934
commit 9d458bd913
5 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/libvirt-domain-snapshot.c
View File

@ -254,8 +254,8 @@ virDomainSnapshotCreateXML(virDomainPtr domain,
* VIR_DOMAIN_SNAPSHOT_XML_SECURE; this flag is rejected on read-only
* connections.
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*/
char *
virDomainSnapshotGetXMLDesc(virDomainSnapshotPtr snapshot,

12
src/libvirt-domain.c
View File

@ -2570,8 +2570,8 @@ virDomainGetControlInfo(virDomainPtr domain,
* XML might not validate against the schema, so it is mainly for
* internal use.
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*/
char *
virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags)
@ -2619,8 +2619,8 @@ virDomainGetXMLDesc(virDomainPtr domain, unsigned int flags)
* generates libvirt domain XML. The format of the native
* data is hypervisor dependent.
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*/
char *
virConnectDomainXMLFromNative(virConnectPtr conn,
@ -2669,8 +2669,8 @@ virConnectDomainXMLFromNative(virConnectPtr conn,
* a native configuration file describing the domain.
* The format of the native data is hypervisor dependent.
*
* Returns a 0 terminated UTF-8 encoded native config datafile, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded native config datafile, or
* NULL in case of error. The caller must free() the returned value.
*/
char *
virConnectDomainXMLToNative(virConnectPtr conn,

4
src/libvirt-interface.c
View File

@ -403,8 +403,8 @@ virInterfaceGetMACString(virInterfacePtr iface)
* is not set, the ip address and netmask will be the current live
* setting of the interface, not the settings from the config files.
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*/
char *
virInterfaceGetXMLDesc(virInterfacePtr iface, unsigned int flags)

8
src/libvirt-network.c
View File

@ -783,8 +783,8 @@ virNetworkGetUUIDString(virNetworkPtr network, char *buf)
* VIR_NETWORK_XML_INACTIVE, then the expansion of virtual interfaces is
* not performed.
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*/
char *
virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
@ -820,8 +820,8 @@ virNetworkGetXMLDesc(virNetworkPtr network, unsigned int flags)
* Provides a bridge interface name to which a domain may connect
* a network interface in order to join the network.
*
* Returns a 0 terminated interface name, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated interface name, or NULL in case of
* error. The caller must free() the returned value.
*/
char *
virNetworkGetBridgeName(virNetworkPtr network)

8
src/libvirt-nwfilter.c
View File

@ -453,8 +453,8 @@ virNWFilterUndefine(virNWFilterPtr nwfilter)
* Provide an XML description of the network filter. The description may be
* reused later to redefine the network filter with virNWFilterCreateXML().
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*/
char *
virNWFilterGetXMLDesc(virNWFilterPtr nwfilter, unsigned int flags)
@ -770,8 +770,8 @@ virNWFilterBindingDelete(virNWFilterBindingPtr binding)
* Provide an XML description of the network filter. The description may be
* reused later to redefine the network filter with virNWFilterCreateXML().
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case of error.
* the caller must free() the returned value.
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
*/
char *
virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int flags)