Re: [PATCH 02/32] style: Minor corrections to function comments

[David Gibson <david@gibson.dropbear.id.au>]

[-- Attachment #1: Type: text/plain, Size: 2461 bytes --]

On Thu, Nov 17, 2022 at 12:11:09AM +0100, Stefano Brivio wrote:
> On Wed, 16 Nov 2022 15:41:42 +1100
> David Gibson <david@gibson.dropbear.id.au> wrote:
> 
> > Some style issues and a typo.
> > 
> > Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
> > ---
> >  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.

Fixed, thanks.

> 
> >   */
> >  const struct in6_addr *tap_ip6_daddr(const struct ctx *c,
> >  				     const struct in6_addr *src)
> 

-- 
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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]