public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Bruno Haible <bruno@clisp.org>
To: Alejandro Colomar <alx@kernel.org>
Cc: Paul Eggert <eggert@cs.ucla.edu>,
	bug-gnulib@gnu.org, linux-man@vger.kernel.org
Subject: Re: [PATCH v1 1/1] man/man3/strnul.3: New page
Date: Sun, 22 Feb 2026 15:10:03 +0100	[thread overview]
Message-ID: <2947259.IIHS8v3jeM@nimes> (raw)
In-Reply-To: <aZsIJhUxHa1L1cme@devuan>

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.

Bruno




  reply	other threads:[~2026-02-22 14:16 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-21 15:02 [PATCH v1 0/1] Document strnul(3) Alejandro Colomar
2026-02-21 15:02 ` [PATCH v1 1/1] man/man3/strnul.3: New page Alejandro Colomar
2026-02-21 17:41   ` G. Branden Robinson
2026-02-21 19:56     ` Alejandro Colomar
2026-02-21 20:02       ` Simon Josefsson
2026-02-21 20:45         ` Alejandro Colomar
2026-02-21 20:05       ` G. Branden Robinson
2026-02-21 20:55         ` Alejandro Colomar
2026-02-22  1:48   ` Paul Eggert
2026-02-22 11:21     ` Alejandro Colomar
2026-02-22 13:46       ` Alejandro Colomar
2026-02-22 14:10         ` Bruno Haible [this message]
2026-02-22 14:19           ` Alejandro Colomar
2026-02-22 14:21             ` Alejandro Colomar
2026-02-21 15:04 ` [PATCH v1 0/1] Document strnul(3) Alejandro Colomar
2026-02-21 15:09   ` Alejandro Colomar
2026-02-21 20:53 ` [PATCH v2 " Alejandro Colomar
2026-02-21 20:53   ` [PATCH v2 1/1] man/man3/strnul.3: New page Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=2947259.IIHS8v3jeM@nimes \
    --to=bruno@clisp.org \
    --cc=alx@kernel.org \
    --cc=bug-gnulib@gnu.org \
    --cc=eggert@cs.ucla.edu \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox