From nobody Sun Feb 8 03:57:02 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1552525867807767.6943263464096; Wed, 13 Mar 2019 18:11:07 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 24AA630F8DAD; Thu, 14 Mar 2019 01:11:04 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id E12EC1001DC9; Thu, 14 Mar 2019 01:11:03 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 8642341F3F; Thu, 14 Mar 2019 01:11:03 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id x2E1B2ip017721 for ; Wed, 13 Mar 2019 21:11:02 -0400 Received: by smtp.corp.redhat.com (Postfix) id 21E7E6B8DD; Thu, 14 Mar 2019 01:11:02 +0000 (UTC) Received: from blue.redhat.com (ovpn-118-35.phx2.redhat.com [10.3.118.35]) by smtp.corp.redhat.com (Postfix) with ESMTP id D96376B8D1 for ; Thu, 14 Mar 2019 01:10:59 +0000 (UTC) From: Eric Blake To: libvir-list@redhat.com Date: Wed, 13 Mar 2019 20:10:59 -0500 Message-Id: <20190314011059.3759-1-eblake@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH] docs: Consistent spacing in *GetXMLDesc functions X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.49]); Thu, 14 Mar 2019 01:11:04 +0000 (UTC) Content-Type: text/plain; charset="utf-8" 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 --- 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 e= rror. - * 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 e= rror. - * 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 e= rror. - * 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 e= rror. - * 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 *bu= f) * 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 e= rror. - * 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 in= t 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 e= rror. - * 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 e= rror. - * 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 f= lags) --=20 2.20.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list