Re: [PATCH v1 1/1] man/man3/strnul.3: New page

[Alejandro Colomar <alx@kernel.org>]

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

Hi Simon,

On 2026-02-21T21:02:49+0100, Simon Josefsson wrote:
> Alejandro Colomar <alx@kernel.org> writes:
> 
> > Hi Branden,
> >
> > On 2026-02-21T11:41:42-0600, G. Branden Robinson wrote:
> >> Hi Alex,
> >> 
> >> At 2026-02-21T16:02:52+0100, Alejandro Colomar wrote:
> >> > +.SH RETURN VALUE
> >> > +.IR s+strlen(s) .
> >> 
> >> Too cute, in my opinion.  Use English.  :)
> >
> > The thing is, at first I thought, am I going to repeat the same exact
> > words as in the DESCRIPTION?
> >
> > DESCRIPTION
> >      strnul() returns a pointer to the terminating null byte in the
> >      string s.
> >
> > RETURN VALUE
> >      strnul() returns a pointer to the terminating null byte in the
> >      string s.
> >
> > I could remove the DESCRIPTION altogether...  What would you do?
> 
> Use the same style as for strlen:
> 
> DESCRIPTION
>        The  strlen() function calculates the length of the string pointed to by
>        s, excluding the terminating null byte ('\0').

Hmmm, maybe I could do this.

DESCRIPTION
	strnul() calculates the position of the terminating null byte
	in the string pointed to by s.

> 
> RETURN VALUE
>        The strlen() function returns the number of bytes in the string  pointed
>        to by s.
> 
> One says what it does, the other says what it returns.

Thanks!


Have a lovely night!
Alex

> 
> /Simon



-- 
<https://www.alejandro-colomar.es>

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