Re: [PATCH] <linux/rculist.h>: fix kernel-doc notation & warning

From: Paul E. McKenney
Date: Mon Jun 15 2020 - 16:39:31 EST


On Sun, Jun 14, 2020 at 08:45:07PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Fix a kernel-doc warning due to missing a beginning '*' on the
> comment line.
>
> ../include/linux/rculist.h:515: warning: bad line: [@right ][node2 ... ]
>
> Fixes: 35fc0e3b0bd5 ("rculist: Add hlists_swap_heads_rcu")
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Eric W. Biederman <ebiederm@xxxxxxxxxxxx>
> Cc: rcu@xxxxxxxxxxxxxxx

Good eyes, but I took Mauro's similar patch.

Thanx, Paul

> ---
> include/linux/rculist.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- lnx-58-rc1.orig/include/linux/rculist.h
> +++ lnx-58-rc1/include/linux/rculist.h
> @@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(str
> * @right: The hlist head on the right
> *
> * The lists start out as [@left ][node1 ... ] and
> - [@right ][node2 ... ]
> + * [@right ][node2 ... ]
> * The lists end up as [@left ][node2 ... ]
> * [@right ][node1 ... ]
> */
>