public inbox for libc-alpha@sourceware.org
 help / color / mirror / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Zack Weinberg <zackw@panix.com>,
	Alejandro Colomar <colomar.6.4.3@gmail.com>
Cc: mtk.manpages@gmail.com, linux-man <linux-man@vger.kernel.org>,
	GNU C Library <libc-alpha@sourceware.org>
Subject: Re: [PATCH] queue.3: Replace incomplete example by a complete example
Date: Mon, 12 Oct 2020 20:47:46 +0200	[thread overview]
Message-ID: <bacde8dd-7de7-b21e-184a-ee6b2646dd5f@gmail.com> (raw)
In-Reply-To: <CAKCAbMi5W41NviKbYS+V5U5sWk7FEpSj3EAUCJCr-UTr2JCkBw@mail.gmail.com>

Hi Zack,

On 10/12/20 2:53 PM, Zack Weinberg wrote:
> On Sat, Oct 10, 2020 at 3:04 PM Alejandro Colomar via Libc-alpha
> <libc-alpha@sourceware.org> wrote:
>>
>> I think this page needs a big overhaul.
>>
>> First of all, it's a very big page,
>> where it's a bit difficult to go to the subsection you want.
>> Then, the examples are incomplete.
>> And also, the language of the page is weird.
> 
> <sys/queue.h> was, IIUC, originally an implementation detail of the
> original BSD kernel, not intended for use elsewhere. Elsewhere started
> using it anyway, and that's why glibc has it; there was, at one time,
> enough user space software that assumed its existence to make a
> compatibility implementation worthwhile. But I don't think its use
> should be encouraged in new software, and in fact I'm not sure it
> should be documented at all.

Thanks for the input.

From my perspective, not documenting something is a poor 
way of discouraging the use of that something. Instead,
some people just use it badly. I've no problem with
adding a note discouraging the use of the APIs, if that's
the rough consensus, though.

Thanks,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

      reply	other threads:[~2020-10-12 18:47 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-10 19:02 Alejandro Colomar
2020-10-10 19:08 ` Alejandro Colomar
2020-10-11  6:00 ` Michael Kerrisk (man-pages)
2020-10-11  9:03   ` Alejandro Colomar
2020-10-11 12:24     ` Michael Kerrisk (man-pages)
2020-10-12 12:53 ` Zack Weinberg
2020-10-12 18:47   ` Michael Kerrisk (man-pages) [this message]

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=bacde8dd-7de7-b21e-184a-ee6b2646dd5f@gmail.com \
    --to=mtk.manpages@gmail.com \
    --cc=colomar.6.4.3@gmail.com \
    --cc=libc-alpha@sourceware.org \
    --cc=linux-man@vger.kernel.org \
    --cc=zackw@panix.com \
    /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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).