[libvirt] [PATCH] docs: Consistent spacing in *GetXMLDesc functions

Eric Blake posted 1 patch 5 days ago
Test syntax-check passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20190314011059.3759-1-eblake@redhat.com
src/libvirt-domain-snapshot.c |  4 ++--
src/libvirt-domain.c          | 12 ++++++------
src/libvirt-interface.c       |  4 ++--
src/libvirt-network.c         |  8 ++++----
src/libvirt-nwfilter.c        |  8 ++++----
5 files changed, 18 insertions(+), 18 deletions(-)

[libvirt] [PATCH] docs: Consistent spacing in *GetXMLDesc functions

Posted by Eric Blake 5 days ago
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>
---

Pushing under the trivial rule.

 src/libvirt-domain-snapshot.c |  4 ++--
 src/libvirt-domain.c          | 12 ++++++------
 src/libvirt-interface.c       |  4 ++--
 src/libvirt-network.c         |  8 ++++----
 src/libvirt-nwfilter.c        |  8 ++++----
 5 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/src/libvirt-domain-snapshot.c b/src/libvirt-domain-snapshot.c
index 23c0b84d9e..947547627a 100644
--- a/src/libvirt-domain-snapshot.c
+++ b/src/libvirt-domain-snapshot.c
@@ -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,
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 072b92b717..be5b1f6740 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -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,
diff --git a/src/libvirt-interface.c b/src/libvirt-interface.c
index 69415293ed..7228ddca57 100644
--- a/src/libvirt-interface.c
+++ b/src/libvirt-interface.c
@@ -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)
diff --git a/src/libvirt-network.c b/src/libvirt-network.c
index 9f9e0ddaf8..d46a7d5c47 100644
--- a/src/libvirt-network.c
+++ b/src/libvirt-network.c
@@ -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)
diff --git a/src/libvirt-nwfilter.c b/src/libvirt-nwfilter.c
index 3da85adc9e..16eceb6525 100644
--- a/src/libvirt-nwfilter.c
+++ b/src/libvirt-nwfilter.c
@@ -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)
-- 
2.20.1

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list