[tip: core/rcu] rcu: Fix some kernel-doc warnings

From: tip-bot2 for Mauro Carvalho Chehab
Date: Fri Jul 31 2020 - 05:24:37 EST


The following commit has been merged into the core/rcu branch of tip:

Commit-ID: 24692fa22c30cb8fcfcabdc07a3c82964475b639
Gitweb: https://git.kernel.org/tip/24692fa22c30cb8fcfcabdc07a3c82964475b639
Author: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
AuthorDate: Mon, 15 Jun 2020 08:46:49 +02:00
Committer: Paul E. McKenney <paulmck@xxxxxxxxxx>
CommitterDate: Mon, 29 Jun 2020 11:58:51 -07:00

rcu: Fix some kernel-doc warnings

The current code provokes some kernel-doc warnings:

./kernel/rcu/tree.c:2915: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'
./include/linux/rculist.h:517: warning: bad line: [@right ][node2 ... ]
./include/linux/rculist.h:2: WARNING: Unexpected indentation.

This commit therefore moves the comment for "count" to the kernel-doc
markup and adds a missing "*" on one kernel-doc continuation line.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxx>
---
include/linux/rculist.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/rculist.h b/include/linux/rculist.h
index df587d1..7eed65b 100644
--- a/include/linux/rculist.h
+++ b/include/linux/rculist.h
@@ -512,7 +512,7 @@ static inline void hlist_replace_rcu(struct hlist_node *old,
* @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 ... ]
*/