On 2026-02-22T15:19:35+0100, Alejandro Colomar wrote:
> Hi Bruno,
> 
> On 2026-02-22T15:10:03+0100, Bruno Haible wrote:
> > Alejandro Colomar wrote:
> > >    .B #include <string.h>
> > >    .P
> > >   -.BI char\~*strnul(const\~char\~* s );
> > >   +.BI QChar\~*strnul(QChar\~* s );
> > >    .fi
> > 
> > Ouch. This is not understandable. Why should a user learn about what 'QChar'
> > is??
> > 
> > It's basically like a C++ template with 2 instantiations. Just list them
> > explicitly; this will be much clearer.
> > 
> > It's common that the SYNOPSIS section has several lines. For example,
> > man1/locale.1 has 4 separate lines.
> 
> Hmmm; sounds reasonable.  I'll do that.

I've amended the commit to do that:

        commit 0dffb0e8afdd3b025a6001a342b2f49f179a8914 (HEAD -> contrib)
        Author: Alejandro Colomar <[email protected]>
        Date:   2026-02-22 14:34:36 +0100

            man/man3/strnul.3: SYNOPSIS: Document that it's a const-generic API
            
            Document it as two overloads (C++-style).
            
            Reported-by: Paul Eggert <[email protected]>
            Suggested-by: Bruno Haible <[email protected]>
            Signed-off-by: Alejandro Colomar <[email protected]>

        diff --git a/man/man3/strnul.3 b/man/man3/strnul.3
        index 714b4d191cae..a92ced866a02 100644
        --- a/man/man3/strnul.3
        +++ b/man/man3/strnul.3
        @@ -12,7 +12,8 @@ .SH SYNOPSIS
         .nf
         .B #include <string.h>
         .P
        -.BI char\~*strnul(const\~char\~* s );
        +.BI char\~*strnul(char\~* s );
        +.BI const\~char\~*strnul(const\~char\~* s );
         .fi
         .SH DESCRIPTION
         .BR strnul ()

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

Attachment: signature.asc
Description: PGP signature

Reply via email to