linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Alejandro Colomar <colomar.6.4.3@gmail.com>
Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org,
	libc-alpha@sourceware.org
Subject: Re: [PATCH 0/8] stailq.3
Date: Sun, 25 Oct 2020 10:13:22 +0100	[thread overview]
Message-ID: <3cf3ba82-cca3-7b01-3874-e374f40eb830@gmail.com> (raw)
In-Reply-To: <20201024222115.6362-1-colomar.6.4.3@gmail.com>

Hi Alex,

On 10/25/20 12:21 AM, Alejandro Colomar wrote:
> Hi Michael,

Thanks! I've merged and pushed this series of patches.

> It's almost done.

Yup!

> I'm thinking about what to do with queue.3.
> You can see its current contents in my branch 'queue'.
> Do you have any suggestions for it?

How about:

====

Change

[[
These macros define and operate...
]]

to:

[[
The <sys/queue.h> header file provides a set of 
macros that define and operate...
]]

====

Split up the remainder of the DESCRIPTION using subsections:

[[
.SS Singly-linked lists (SLIST)
Singly-linked lists are the simplest
and support only the above functionality.
...
For further details, see
.BR slist (3).
...
]]

Would that be workable?

====

Rather than writing your lists as:

[[
.TP
-
Insertion of a new entry at the head of the list.
.TP
-
Insertion of a new entry after any element in the list.
...
]]

I'd prefer:

[[
.IP * 3
Insertion of a new entry at the head of the list.
.IP *
Insertion of a new entry after any element in the list.
...
]]

Thanks,

Michael

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

      parent reply	other threads:[~2020-10-25  9:13 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-24 22:21 [PATCH 0/8] stailq.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 1/8] stailq.3: New page that will hold the (stailq) contents of queue.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 2/8] queue.3, stailq.3: NAME: Move code from queue.3 to stailq.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 3/8] queue.3, stailq.3: SYNOPSIS: " Alejandro Colomar
2020-10-24 22:21 ` [PATCH 4/8] queue.3, stailq.3: DESCRIPTION: Move stailq specific " Alejandro Colomar
2020-10-24 22:21 ` [PATCH 5/8] queue.3, stailq.3: EXAMPLES: Move stailq example " Alejandro Colomar
2020-10-24 22:21 ` [PATCH 6/8] stailq.3: Copy and adapt code from queue.3 Alejandro Colomar
2020-10-24 22:21 ` [PATCH 7/8] stailq.3: ffix: Use man markup Alejandro Colomar
2020-10-24 22:21 ` [PATCH 8/8] stailq.3: Add remaining details to complete the page Alejandro Colomar
2020-10-24 22:30 ` [PATCH 09/10] STAILQ_CONCAT.3, STAILQ_EMPTY.3, STAILQ_ENTRY.3, STAILQ_FIRST.3, STAILQ_FOREACH.3, STAILQ_HEAD.3, STAILQ_HEAD_INITIALIZER.3, STAILQ_INIT.3, STAILQ_INSERT_AFTER.3, STAILQ_INSERT_HEAD.3, STAILQ_INSERT_TAIL.3, STAILQ_NEXT.3, STAILQ_REMOVE.3, STAILQ_REMOVE_HEAD.3: Link to the new stailq(3) page instead of queue(3) Alejandro Colomar
2020-10-24 22:30 ` [PATCH 10/10] queue.3: SEE ALSO: Add stailq(3) Alejandro Colomar
2020-10-25  9:13 ` 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=3cf3ba82-cca3-7b01-3874-e374f40eb830@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 \
    /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 NNTP newsgroup(s).