From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from gandalf.ozlabs.org (gandalf.ozlabs.org [150.107.74.76]) by passt.top (Postfix) with ESMTPS id 0BA255A0082 for ; Thu, 17 Nov 2022 03:08:53 +0100 (CET) Received: by gandalf.ozlabs.org (Postfix, from userid 1007) id 4NCNcx24fHz4xZ3; Thu, 17 Nov 2022 13:08:49 +1100 (AEDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gibson.dropbear.id.au; s=201602; t=1668650929; bh=dAMo6DRyWVNUr1zsFZbx+D7Swet0iWlK80yEo8eeCZ0=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=n830QP0A5RV0HNDcb19V0qZb23WBZo8b5RziTfE3QnFrO2rndmD5N8CGXSpx0dy8R tlyKypgAATMGR1uwkrmCoM2s7ZBYgIc3zo+gOzITKzu2WeVzpBjxV1ZDDwhl4WCrGS K2/h3cNrQXg1+ABpawtCm8w1tN0V7ro2dbmEF8iY= Date: Thu, 17 Nov 2022 12:21:46 +1100 From: David Gibson To: Stefano Brivio Subject: Re: [PATCH 02/32] style: Minor corrections to function comments Message-ID: References: <20221116044212.3876516-1-david@gibson.dropbear.id.au> <20221116044212.3876516-3-david@gibson.dropbear.id.au> <20221117001109.33f791a4@elisabeth> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="UXbIgaCeoLtPut0i" Content-Disposition: inline In-Reply-To: <20221117001109.33f791a4@elisabeth> Message-ID-Hash: NV6X3E2KEDRMNQZO6HSEPJN3EZQWBZGY X-Message-ID-Hash: NV6X3E2KEDRMNQZO6HSEPJN3EZQWBZGY X-MailFrom: dgibson@gandalf.ozlabs.org X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: passt-dev@passt.top X-Mailman-Version: 3.3.3 Precedence: list List-Id: Development discussion and patches for passt Archived-At: Archived-At: List-Archive: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: --UXbIgaCeoLtPut0i Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Nov 17, 2022 at 12:11:09AM +0100, Stefano Brivio wrote: > On Wed, 16 Nov 2022 15:41:42 +1100 > David Gibson wrote: >=20 > > Some style issues and a typo. > >=20 > > Signed-off-by: David Gibson > > --- > > conf.c | 6 +++--- > > tap.c | 6 +++--- > > 2 files changed, 6 insertions(+), 6 deletions(-) > >=20 > > diff --git a/conf.c b/conf.c > > index 1adcf83..3ad247e 100644 > > --- a/conf.c > > +++ b/conf.c > > @@ -112,9 +112,9 @@ static int get_bound_ports_ns(void *arg) > > * @s: String to search > > * @c: Delimiter character > > * > > - * Returns: If another @c is found in @s, returns a pointer to the > > - * character *after* the delimiter, if no further @c is in > > - * @s, return NULL > > + * Return: If another @c is found in @s, returns a pointer to the > > + * character *after* the delimiter, if no further @c is in @s, > > + * return NULL > > */ > > static char *next_chunk(const char *s, char c) > > { > > diff --git a/tap.c b/tap.c > > index abeff25..707660c 100644 > > --- a/tap.c > > +++ b/tap.c > > @@ -90,7 +90,7 @@ int tap_send(const struct ctx *c, const void *data, s= ize_t len) > > * tap_ip4_daddr() - Normal IPv4 destination address for inbound packe= ts > > * @c: Execution context > > * > > - * Returns: IPv4 address, network order > > + * Return: IPv4 address, network order >=20 > Loosely based on kerneldoc style: single space after "Return: " is the > style adopted everywhere else. Rationale: it doesn't need to be aligned > with anything else. >=20 > > */ > > struct in_addr tap_ip4_daddr(const struct ctx *c) > > { > > @@ -98,11 +98,11 @@ struct in_addr tap_ip4_daddr(const struct ctx *c) > > } > > =20 > > /** > > - * tap_ip6_daddr() - Normal IPv4 destination address for inbound packe= ts > > + * tap_ip6_daddr() - Normal IPv6 destination address for inbound packe= ts > > * @c: Execution context > > * @src: Source address > > * > > - * Returns: pointer to IPv6 address > > + * Return: pointer to IPv6 address >=20 > Same here. Fixed, thanks. >=20 > > */ > > const struct in6_addr *tap_ip6_daddr(const struct ctx *c, > > const struct in6_addr *src) >=20 --=20 David Gibson | I'll have my music baroque, and my code david AT gibson.dropbear.id.au | minimalist, thank you. NOT _the_ _other_ | _way_ _around_! http://www.ozlabs.org/~dgibson --UXbIgaCeoLtPut0i Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEoULxWu4/Ws0dB+XtgypY4gEwYSIFAmN1jKQACgkQgypY4gEw YSKP7A//c8ejfPM7YNUHhzZM5UaohFbe/fZmM29dGHKFK/1FWHnp9PuNs2xFK4U/ lxuSqQXpaTBH9K8YPxfGkeaMSRkPiqUdH9IXt/lgo45P3ChlKgzpi80gYQtICHCM N0HL05ZaFwU20QJaSy51ZsDdvWQzE8RuijUFV8JNWQsPwe/Da8F4/m3mGG99upK/ 5BMs2wY4CM7wI3D3xQ+26DUjfc4AKHc+m6MLeDJiA6JnC9qyklcqOScmmeih3lKk vGM5G+xSZafYsAmOtlp+WY49r7aqWdsRiH9oI6pqTkDjVfEJ71d6cnToJweauBPC loa6nbvmOxP+BNAzEVJmssves4SzkGesnAxeFNZX97R8stNiHqWEuI9gSm0ipi0W K5bA+SJXcSTQpin9bfvj+o7IE9nG9DfVmfKUMUWYG46yKwZ1b/W1yvJGTN1kRtB/ cLY0pU4zTkgbwGMg8imxHsHN5Ko7Hm6Uc+nCOY84+uTxyM4MH+mzdQ1uNpRx9YjT U7AQMYWlss7LJjYG6NBHrUJMQfZSGA30YskYThUPqu/ECPIN6zPGCiZ0gIXuinAa 12hftgrkue4XhEL+HTXZQbArkYzMtLFovy8kZoKQCYAsv50WoYuaKuWyPZf336kJ LBoJirDhRfvXnGqGVKgf0ZUxjbN6yxutV8OiKfumiXJBXl1ReHg= =6eEV -----END PGP SIGNATURE----- --UXbIgaCeoLtPut0i--