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

["Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>]

A minor correction below:

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.)
> - 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,
>   and add subsections to DESCRIPTION.
> - 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>
> ---
>  man3/circleq.3 | 199 ++++++++++++++++++----------------------
>  man3/list.3    | 159 +++++++++++++++-----------------
>  man3/slist.3   | 159 +++++++++++++++-----------------
>  man3/stailq.3  | 184 +++++++++++++++++--------------------
>  man3/tailq.3   | 241 +++++++++++++++++++++++--------------------------
>  5 files changed, 433 insertions(+), 509 deletions(-)
> 

[...]
> diff --git a/man3/slist.3 b/man3/slist.3
> index 6868a63c2..1b041773e 100644
> --- a/man3/slist.3
> +++ b/man3/slist.3
[...]
> @@ -200,30 +218,21 @@ turn to
[...]
> -.PP
> -The macro
> -.BR SLIST_NEXT ()
> -returns the next element in the list.
> +from the head of the list.
> +For optimum efficiency,
> +elements being removed from the head of the list
> +should explicitly use this macro instead of the generic
> +.IR SLIST_REMOVE ().

s/.IR/.BR/

[...]

-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/