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

[Simon Josefsson <simon@josefsson.org>]

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

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').

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.

/Simon

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