Linux Manual Pages development
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: Alejandro Colomar <alx+linux-man@kernel.org>,
	 Rich Felker <dalias@libc.org>,
	Vincent Lefevre <vincent@vinc17.net>,
	linux-man@vger.kernel.org,  libc-alpha@sourceware.org,
	Walter Harms <wharms@bfs.de>,
	~hallyn/shadow@lists.sr.ht,  musl@lists.openwall.com
Subject: Re: [musl] Re: [PATCH v1] man/man3/crypt.3: These functions accept many algorithms, not only DES
Date: Thu, 12 Nov 2026 14:12:21 +0100	[thread overview]
Message-ID: <avW2G8eKE5w0Xy9O@devuan> (raw)
In-Reply-To: <20261112124114.GB3542221@port70.net>

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

Hi Szabolcs,

> Date: 2026-11-12 13:41:14+0100
> From: Szabolcs Nagy <nsz@port70.net>
>
> * Alejandro Colomar <alx+linux-man@kernel.org> [2026-11-12 13:27:13 +0100]:
> > How about something this (we can improve the wording)?
> > 
> > 	diff --git i/man/man3/crypt.3 w/man/man3/crypt.3
> > 	index 524781d3c2a0..d579bc5394fb 100644
> > 	--- i/man/man3/crypt.3
> > 	+++ w/man/man3/crypt.3
> > 	@@ -111,6 +111,9 @@ .SH ATTRIBUTES
> > 	 .BR crypt_r ()
> > 	 T}     Thread safety   MT-Safe
> > 	 .TE
> > 	+.SH VERSIONS
> > 	+POSIX specifies a quite useless API,
> > 	+and all systems extend it significantly.
> 
> please don't put nonsense into the official man pages.

I agree I could have used more precise wording.

I think you could have used more precise wording too, since you're
complaining about that.  What is nonsense in what I said?  Is it perhaps
too offensive?  Yes; I think I should have said s/useless/limited/.

Is it completely nonsense?  I think not.

> your job

Ironically, your job is *not* to judge or specify my job (if it's a job
at all).

I suggest that you limit yourself to comment on what *the manual pages*
should say, rather than on what *I* should do.

I'll continue as if you had said s/your job/the job of the manual pages/

> is to document the interface contract including
> implementation defined behaviour,

The contract is specified in the sections of the manual page that are
meant for that, such as DESCRIPTION, RETURN VALUE, etc.

VERSIONS is a section for discussing differences between
implementations, and between implementations and the spec (although this
might also go in STANDARDS; it's a blurry line).

> not to judge the spec

I do agree that we should not judge the spec unnecessarily.

But about what you said literally, I disagree.  The manual pages have
been full of opinions --where appropriate-- since the very early times
of manual pages.  Already in the early BSDs there were comments about
strncpy(3), for example.

Here's some of them:

	$ git show man-pages-5.00:man3/strcpy.3 \
	| MANWIDTH=64 lman /dev/stdin \
	| grep -A5 NOTES;
	NOTES
	     Some  programmers consider strncpy() to be inefficient and
	     error prone.  If the programmer knows (i.e., includes code
	     to test!)  that the size  of  dest  is  greater  than  the
	     length of src, then strcpy() can be used.

See <https://lore.kernel.org/linux-man/anJZza-qbi_y5r1N@devuan/> for
a (incomplete) list of historic counter-examples.

> and other systems.

I didn't judge other systems, I think.


Have a lovely day!
Alex

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

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

  reply	other threads:[~2026-11-12 13:12 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-09 23:58 [PATCH v1] man/man3/crypt.3: These functions accept many algorithms, not only DES Alejandro Colomar
2026-11-10  0:01 ` Alejandro Colomar
2026-11-11 15:05   ` Serge E. Hallyn
2026-11-11 18:55     ` Alejandro Colomar
2026-11-11 21:13       ` [musl] " Rich Felker
2026-11-11 21:43         ` Alejandro Colomar
2026-11-12  1:52   ` Vincent Lefevre
2026-11-12  2:53     ` Rich Felker
2026-11-12  3:29       ` Vincent Lefevre
2026-11-12  3:37         ` [musl] " Rich Felker
2026-11-12 10:28           ` Alejandro Colomar
2026-11-12 11:40             ` Vincent Lefevre
2026-11-12 12:08               ` Alejandro Colomar
2026-11-12 13:15                 ` Vincent Lefevre
2026-11-12 13:26                   ` Alejandro Colomar
2026-11-12 12:08             ` Rich Felker
2026-11-12 12:27               ` Alejandro Colomar
2026-11-12 12:41                 ` Szabolcs Nagy
2026-11-12 13:12                   ` Alejandro Colomar [this message]
2026-11-12 13:27                     ` Vincent Lefevre
2026-11-12 13:17                 ` Vincent Lefevre
2026-11-12 13:23                   ` Alejandro Colomar
2026-11-12 13:45                     ` Vincent Lefevre
2026-11-12 13:55                       ` Rich Felker
2026-11-12 14:07                         ` Alejandro Colomar
2026-11-12 14:43                           ` Rich Felker

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=avW2G8eKE5w0Xy9O@devuan \
    --to=alx@kernel.org \
    --cc=alx+linux-man@kernel.org \
    --cc=dalias@libc.org \
    --cc=libc-alpha@sourceware.org \
    --cc=linux-man@vger.kernel.org \
    --cc=musl@lists.openwall.com \
    --cc=vincent@vinc17.net \
    --cc=wharms@bfs.de \
    --cc=~hallyn/shadow@lists.sr.ht \
    /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