mbox series

[0/8] stailq.3

Message ID 20201024222115.6362-1-colomar.6.4.3@gmail.com
Headers show
Series stailq.3 | expand

Message

Alejandro Colomar Oct. 24, 2020, 10:21 p.m. UTC
Hi Michael,

It's almost done.  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?

Thanks,

A

Alejandro Colomar (8):
  stailq.3: New page that will hold the (stailq) contents of queue.3
  queue.3, stailq.3: NAME: Move code from queue.3 to stailq.3
  queue.3, stailq.3: SYNOPSIS: Move code from queue.3 to stailq.3
  queue.3, stailq.3: DESCRIPTION: Move stailq specific code from queue.3
    to stailq.3
  queue.3, stailq.3: EXAMPLES: Move stailq example from queue.3 to
    stailq.3
  stailq.3: Copy and adapt code from queue.3
  stailq.3: ffix: Use man markup
  stailq.3: Add remaining details to complete the page

 man3/queue.3  | 279 -----------------------------------
 man3/stailq.3 | 391 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 391 insertions(+), 279 deletions(-)
 create mode 100644 man3/stailq.3

Comments

Michael Kerrisk \(man-pages\) Oct. 25, 2020, 9:13 a.m. UTC | #1
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