[PATCH 0/8] stailq.3

Michael Kerrisk (man-pages) mtk.manpages@gmail.com
Sun Oct 25 09:13:22 GMT 2020


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/


More information about the Libc-alpha mailing list