Re: [PATCH] circleq.3, list.3, slist.3, stailq.3: Fix return type of macros

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

On 10/25/20 10:19 AM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>

Thanks, Alex. Patch applied.

Cheers,

Michael

> ---
>  man3/circleq.3 | 10 +++++-----
>  man3/list.3    |  8 ++++----
>  man3/slist.3   |  6 +++---
>  man3/stailq.3  |  8 ++++----
>  4 files changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/man3/circleq.3 b/man3/circleq.3
> index 54df3fa20..a70a22079 100644
> --- a/man3/circleq.3
> +++ b/man3/circleq.3
> @@ -58,7 +58,7 @@ CIRCLEQ_REMOVE
>  .PP
>  .B CIRCLEQ_ENTRY(TYPE);
>  .PP
> -.BI "CIRCLEQ_ENTRY *CIRCLEQ_FIRST(CIRCLEQ_HEAD *" head ");"
> +.BI "TYPE *CIRCLEQ_FIRST(CIRCLEQ_HEAD *" head ");"
>  .PP
>  .BI "CIRCLEQ_FOREACH(TYPE *" var ", CIRCLEQ_HEAD *" head ", CIRCLEQ_ENTRY " NAME ");"
>  .PP
> @@ -83,7 +83,7 @@ CIRCLEQ_REMOVE
>  .BI "void CIRCLEQ_INSERT_TAIL(CIRCLEQ_HEAD *" head ", TYPE *" elm ","
>  .BI "                CIRCLEQ_ENTRY " NAME ");"
>  .PP
> -.BI "CIRCLEQ_ENTRY *CIRCLEQ_LAST(CIRCLEQ_HEAD *" head ");"
> +.BI "TYPE *CIRCLEQ_LAST(CIRCLEQ_HEAD *" head ");"
>  .PP
>  .BI "void CIRCLEQ_LOOP_NEXT(CIRCLEQ_HEAD *" head ", TYPE *" elm ","
>  .BI "                CIRCLEQ_ENTRY " NAME ");"
> @@ -91,9 +91,9 @@ CIRCLEQ_REMOVE
>  .BI "void CIRCLEQ_LOOP_PREV(CIRCLEQ_HEAD *" head ", TYPE *" elm ","
>  .BI "                CIRCLEQ_ENTRY " NAME ");"
>  .PP
> -.BI "CIRCLEQ_ENTRY *CIRCLEQ_NEXT(TYPE *" elm ", CIRCLEQ_ENTRY " NAME ");"
> +.BI "TYPE *CIRCLEQ_NEXT(TYPE *" elm ", CIRCLEQ_ENTRY " NAME ");"
>  .PP
> -.BI "CIRCLEQ_ENTRY *CIRCLEQ_PREV(TYPE *" elm ", CIRCLEQ_ENTRY " NAME ");"
> +.BI "TYPE *CIRCLEQ_PREV(TYPE *" elm ", CIRCLEQ_ENTRY " NAME ");"
>  .PP
>  .BI "void CIRCLEQ_REMOVE(CIRCLEQ_HEAD *" head ", TYPE *" elm ", CIRCLEQ_ENTRY " NAME ");"
>  .fi
> @@ -266,7 +266,7 @@ and zero if the queue contains at least one entry.
>  and
>  .BR CIRCLEQ_PREV ()
>  return a pointer to the first, last, next or previous
> -.I CIRCLEQ_ENTRY
> +.I TYPE
>  structure, respectively.
>  .PP
>  .BR CIRCLEQ_HEAD_INITIALIZER ()
> diff --git a/man3/list.3 b/man3/list.3
> index 4c07a1fab..cbe8b8d1c 100644
> --- a/man3/list.3
> +++ b/man3/list.3
> @@ -57,7 +57,7 @@ LIST_REMOVE
>  .PP
>  .B LIST_ENTRY(TYPE);
>  .PP
> -.BI "LIST_ENTRY *LIST_FIRST(LIST_HEAD *" head ");"
> +.BI "TYPE *LIST_FIRST(LIST_HEAD *" head ");"
>  .PP
>  .BI "LIST_FOREACH(TYPE *" var ", LIST_HEAD *" head ", LIST_ENTRY " NAME ");"
>  .\".PP
> @@ -79,9 +79,9 @@ LIST_REMOVE
>  .PP
>  .BI "void LIST_INSERT_HEAD(LIST_HEAD *" head ", TYPE *" elm ", LIST_ENTRY " NAME ");"
>  .PP
> -.BI "LIST_ENTRY *LIST_NEXT(TYPE *" elm ", LIST_ENTRY " NAME ");"
> +.BI "TYPE *LIST_NEXT(TYPE *" elm ", LIST_ENTRY " NAME ");"
>  .\".PP
> -.\".BI "LIST_ENTRY LIST_PREV(TYPE *" elm ", LIST_HEAD *" head ", TYPE, LIST_ENTRY " NAME ");"
> +.\".BI "TYPE *LIST_PREV(TYPE *" elm ", LIST_HEAD *" head ", TYPE, LIST_ENTRY " NAME ");"
>  .PP
>  .BI "void LIST_REMOVE(TYPE *" elm ", LIST_ENTRY " NAME ");"
>  .\".PP
> @@ -264,7 +264,7 @@ and zero if the list contains at least one entry.
>  and
>  .BR LIST_NEXT ()
>  return a pointer to the first or next
> -.I LIST_ENTRY
> +.I TYPE
>  structure, respectively.
>  .PP
>  .BR LIST_HEAD_INITIALIZER ()
> diff --git a/man3/slist.3 b/man3/slist.3
> index c0182f804..b514f3576 100644
> --- a/man3/slist.3
> +++ b/man3/slist.3
> @@ -57,7 +57,7 @@ SLIST_REMOVE_HEAD
>  .PP
>  .B SLIST_ENTRY(TYPE);
>  .PP
> -.BI "SLIST_ENTRY *SLIST_FIRST(SLIST_HEAD *" head ");"
> +.BI "TYPE *SLIST_FIRST(SLIST_HEAD *" head ");"
>  .PP
>  .BI "SLIST_FOREACH(TYPE *" var ", SLIST_HEAD *" head ", SLIST_ENTRY " NAME ");"
>  .\".PP
> @@ -77,7 +77,7 @@ SLIST_REMOVE_HEAD
>  .PP
>  .BI "void SLIST_INSERT_HEAD(SLIST_HEAD *" head ", TYPE *" elm ", SLIST_ENTRY " NAME ");"
>  .PP
> -.BI "SLIST_ENTRY *SLIST_NEXT(TYPE *" elm ", SLIST_ENTRY " NAME ");"
> +.BI "TYPE *SLIST_NEXT(TYPE *" elm ", SLIST_ENTRY " NAME ");"
>  .PP
>  .BI "void SLIST_REMOVE(SLIST_HEAD *" head ", TYPE *" elm ", SLIST_ENTRY " NAME ");"
>  .\".PP
> @@ -270,7 +270,7 @@ and zero if the list contains at least one entry.
>  and
>  .BR SLIST_NEXT ()
>  return a pointer to the first or next
> -.I SLIST_ENTRY
> +.I TYPE
>  structure, respectively.
>  .PP
>  .BR SLIST_HEAD_INITIALIZER ()
> diff --git a/man3/stailq.3 b/man3/stailq.3
> index 2896d27c9..01b6107b5 100644
> --- a/man3/stailq.3
> +++ b/man3/stailq.3
> @@ -62,7 +62,7 @@ STAILQ_REMOVE_HEAD,
>  .PP
>  .B STAILQ_ENTRY(TYPE);
>  .PP
> -.BI "STAILQ_ENTRY *STAILQ_FIRST(STAILQ_HEAD *" head ");"
> +.BI "TYPE *STAILQ_FIRST(STAILQ_HEAD *" head ");"
>  .PP
>  .BI "STAILQ_FOREACH(TYPE *" var ", STAILQ_HEAD *" head ", STAILQ_ENTRY " NAME ");"
>  .\" .PP
> @@ -85,9 +85,9 @@ STAILQ_REMOVE_HEAD,
>  .PP
>  .BI "void STAILQ_INSERT_TAIL(STAILQ_HEAD *" head ", TYPE *" elm ", STAILQ_ENTRY " NAME ");"
>  .\" .PP
> -.\" .BI "STAILQ_ENTRY *STAILQ_LAST(STAILQ_HEAD *" head ", TYPE *" elm ", STAILQ_ENTRY " NAME ");"
> +.\" .BI "TYPE *STAILQ_LAST(STAILQ_HEAD *" head ", TYPE *" elm ", STAILQ_ENTRY " NAME ");"
>  .PP
> -.BI "STAILQ_ENTRY *STAILQ_NEXT(TYPE *" elm ", STAILQ_ENTRY " NAME ");"
> +.BI "TYPE *STAILQ_NEXT(TYPE *" elm ", STAILQ_ENTRY " NAME ");"
>  .PP
>  .BI "void STAILQ_REMOVE(STAILQ_HEAD *" head ", TYPE *" elm ", TYPE,"
>  .BI "                STAILQ_ENTRY " NAME ");"
> @@ -303,7 +303,7 @@ and zero if the queue contains at least one entry.
>  and
>  .BR STAILQ_NEXT ()
>  return a pointer to the first or next
> -.I STAILQ_ENTRY
> +.I TYPE
>  structure, respectively.
>  .PP
>  .BR STAILQ_HEAD_INITIALIZER ()
> 


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