[tip: core/rcu] rcu: Fix a kernel-doc warnings for "count"

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


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

Commit-ID: 8e11690d2f5a9823d66f68918c3986b4e9e160ab
Gitweb: https://git.kernel.org/tip/8e11690d2f5a9823d66f68918c3986b4e9e160ab
Author: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
AuthorDate: Mon, 04 May 2020 14:35:00 +02:00
Committer: Paul E. McKenney <paulmck@xxxxxxxxxx>
CommitterDate: Mon, 29 Jun 2020 11:59:24 -07:00

rcu: Fix a kernel-doc warnings for "count"

There are some kernel-doc warnings:

./kernel/rcu/tree.c:2915: warning: Function parameter or member 'count' not described in 'kfree_rcu_cpu'

This commit therefore moves the comment for "count" to the kernel-doc
markup.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxx>
---
kernel/rcu/tree.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index 6c6569e..ba4c477 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -3004,6 +3004,7 @@ struct kfree_rcu_cpu_work {
* @monitor_work: Promote @head to @head_free after KFREE_DRAIN_JIFFIES
* @monitor_todo: Tracks whether a @monitor_work delayed work is pending
* @initialized: The @lock and @rcu_work fields have been initialized
+ * @count: Number of objects for which GP not started
*
* This is a per-CPU structure. The reason that it is not included in
* the rcu_data structure is to permit this code to be extracted from
@@ -3019,7 +3020,6 @@ struct kfree_rcu_cpu {
struct delayed_work monitor_work;
bool monitor_todo;
bool initialized;
- // Number of objects for which GP not started
int count;
};