OSDN Git Service

rcu/tree: docs: document bkvcache new members at struct kfree_rcu_cpu
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 10 Sep 2020 08:20:34 +0000 (10:20 +0200)
committerMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Thu, 15 Oct 2020 05:57:55 +0000 (07:57 +0200)
Changeset 53c72b590b3a ("rcu/tree: cache specified number of objects")
added new members for struct kfree_rcu_cpu, but didn't add the
corresponding at the kernel-doc markup, as repoted when doing
"make htmldocs":
./kernel/rcu/tree.c:3113: warning: Function parameter or member 'bkvcache' not described in 'kfree_rcu_cpu'
./kernel/rcu/tree.c:3113: warning: Function parameter or member 'nr_bkv_objs' not described in 'kfree_rcu_cpu'

So, move the description for bkvcache to kernel-doc, and add a
description for nr_bkv_objs.

Fixes: 53c72b590b3a ("rcu/tree: cache specified number of objects")
Acked-by: Paul E. McKenney <paulmck@kernel.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
kernel/rcu/tree.c

index f78ee75..03c54c3 100644 (file)
@@ -3022,6 +3022,12 @@ struct kfree_rcu_cpu_work {
  * @monitor_todo: Tracks whether a @monitor_work delayed work is pending
  * @initialized: The @rcu_work fields have been initialized
  * @count: Number of objects for which GP not started
+ * @bkvcache:
+ *     A simple cache list that contains objects for reuse purpose.
+ *     In order to save some per-cpu space the list is singular.
+ *     Even though it is lockless an access has to be protected by the
+ *     per-cpu lock.
+ * @nr_bkv_objs: number of allocated objects at @bkvcache.
  *
  * 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
@@ -3037,14 +3043,6 @@ struct kfree_rcu_cpu {
        bool monitor_todo;
        bool initialized;
        int count;
-
-       /*
-        * A simple cache list that contains objects for
-        * reuse purpose. In order to save some per-cpu
-        * space the list is singular. Even though it is
-        * lockless an access has to be protected by the
-        * per-cpu lock.
-        */
        struct llist_head bkvcache;
        int nr_bkv_objs;
 };