From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by passt.top (Postfix) with ESMTP id 51D085A0082 for ; Thu, 17 Nov 2022 00:53:48 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1668642827; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Um7tCFnaUZT5sLpxp+VtwafJM0Na4xTDnXOltE8CZEA=; b=NI00QQlLqlBP7FswdW0Y4nFtbdupnSz7mw/wjORhtZ79kXqdDwMwKiULXFcBKuPFqO4CY6 uXRGsTfkRTN77ZVYHGqGBKUVobOqcM4queUki5+pD6729K38eMScjjZWi6Uz419seOUc5g lRt9K1UgXJFsHU6/5JTVzhyI19pg5Bg= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-277-T_YrMa9aNvugBqnxc4WqRg-1; Wed, 16 Nov 2022 18:53:44 -0500 X-MC-Unique: T_YrMa9aNvugBqnxc4WqRg-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id CB835101A528; Wed, 16 Nov 2022 23:53:43 +0000 (UTC) Received: from maya.cloud.tilaa.com (ovpn-208-8.brq.redhat.com [10.40.208.8]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 99574C1E87F; Wed, 16 Nov 2022 23:53:43 +0000 (UTC) Date: Thu, 17 Nov 2022 00:11:09 +0100 From: Stefano Brivio To: David Gibson Subject: Re: [PATCH 02/32] style: Minor corrections to function comments Message-ID: <20221117001109.33f791a4@elisabeth> In-Reply-To: <20221116044212.3876516-3-david@gibson.dropbear.id.au> References: <20221116044212.3876516-1-david@gibson.dropbear.id.au> <20221116044212.3876516-3-david@gibson.dropbear.id.au> Organization: Red Hat MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Message-ID-Hash: XJWJBHEUVSTLTIVUTAGXITXM4DWVH2HH X-Message-ID-Hash: XJWJBHEUVSTLTIVUTAGXITXM4DWVH2HH X-MailFrom: sbrivio@redhat.com 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: On Wed, 16 Nov 2022 15:41:42 +1100 David Gibson wrote: > Some style issues and a typo. > > Signed-off-by: David Gibson > --- > conf.c | 6 +++--- > tap.c | 6 +++--- > 2 files changed, 6 insertions(+), 6 deletions(-) > > 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, size_t len) > * tap_ip4_daddr() - Normal IPv4 destination address for inbound packets > * @c: Execution context > * > - * Returns: IPv4 address, network order > + * Return: IPv4 address, network order 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. > */ > struct in_addr tap_ip4_daddr(const struct ctx *c) > { > @@ -98,11 +98,11 @@ struct in_addr tap_ip4_daddr(const struct ctx *c) > } > > /** > - * tap_ip6_daddr() - Normal IPv4 destination address for inbound packets > + * tap_ip6_daddr() - Normal IPv6 destination address for inbound packets > * @c: Execution context > * @src: Source address > * > - * Returns: pointer to IPv6 address > + * Return: pointer to IPv6 address Same here. > */ > const struct in6_addr *tap_ip6_daddr(const struct ctx *c, > const struct in6_addr *src) -- Stefano