Re: [PATCH v2] circleq.3, list.3, slist.3, stailq.3, tailq.3: Improve readability, especially in SYNOPSIS

["Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>]

Hi Alex,

On 1/5/21 11:39 PM, Alejandro Colomar wrote:
> - Group macros by kinds.
> - Align so that it's easiest to distinguish differences
>   between related macros.
>   (Align all continuations for consistency on PDF.)

(Thanks.)

> - Fix minor typos.
> - Remove redundant text:
>     'The macro xxx() ...':
>         The first paragraph already says that these are macros.
>     'circular|tail|... queue':
>         Don't need to repeat every time.
>         Generic text makes it easier to spot the differences.
> - Fit lines into 78 columns.
> - Reorder descriptions to match SYNOPSIS,

Thanks!

>   and add subsections to DESCRIPTION.

That really helps!

> - srcfix: fix a few smantic newlines.
> 
> I noticed a bug which should be fixed next:
> CIRCLEQ_LOOP_*() return a 'struct TYPE *'.
> 
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

Nice work! Patch applied.

Thanks,

Michael

[...]

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