* [PATCH] rcu: fix some kernel-doc warnings
@ 2020-05-04 12:35 Mauro Carvalho Chehab
2020-05-18 16:48 ` Paul E. McKenney
0 siblings, 1 reply; 2+ messages in thread
From: Mauro Carvalho Chehab @ 2020-05-04 12:35 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, linux-kernel, Jonathan Corbet,
Paul E. McKenney, Josh Triplett, Steven Rostedt,
Mathieu Desnoyers, Lai Jiangshan, Joel Fernandes, rcu
There are 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.
Move the comment for "count" to the kernel-doc markup and add
a missing "*" on one kernel-doc continuation line.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
include/linux/rculist.h | 2 +-
kernel/rcu/tree.c | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/include/linux/rculist.h b/include/linux/rculist.h
index 2ebd112f86f7..7a6fc9956510 100644
--- a/include/linux/rculist.h
+++ b/include/linux/rculist.h
@@ -514,7 +514,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 ... ]
*/
diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
index 8ed0fe57d5fb..ada4f914fa60 100644
--- a/kernel/rcu/tree.c
+++ b/kernel/rcu/tree.c
@@ -2895,6 +2895,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
@@ -2910,7 +2911,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;
};
--
2.25.4
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] rcu: fix some kernel-doc warnings
2020-05-04 12:35 [PATCH] rcu: fix some kernel-doc warnings Mauro Carvalho Chehab
@ 2020-05-18 16:48 ` Paul E. McKenney
0 siblings, 0 replies; 2+ messages in thread
From: Paul E. McKenney @ 2020-05-18 16:48 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, linux-kernel, Jonathan Corbet,
Josh Triplett, Steven Rostedt, Mathieu Desnoyers, Lai Jiangshan,
Joel Fernandes, rcu
On Mon, May 04, 2020 at 02:35:00PM +0200, Mauro Carvalho Chehab wrote:
> There are 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.
>
> Move the comment for "count" to the kernel-doc markup and add
> a missing "*" on one kernel-doc continuation line.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> include/linux/rculist.h | 2 +-
> kernel/rcu/tree.c | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/rculist.h b/include/linux/rculist.h
> index 2ebd112f86f7..7a6fc9956510 100644
> --- a/include/linux/rculist.h
> +++ b/include/linux/rculist.h
> @@ -514,7 +514,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 ... ]
> */
This one has a prerequisite not in my tree, so I dropped this hunk.
Please point me at the prerequisite if it is something that I should
be queueing.
> diff --git a/kernel/rcu/tree.c b/kernel/rcu/tree.c
> index 8ed0fe57d5fb..ada4f914fa60 100644
> --- a/kernel/rcu/tree.c
> +++ b/kernel/rcu/tree.c
> @@ -2895,6 +2895,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
> @@ -2910,7 +2911,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;
> };
>
I queued this one.
If this is going up some other path, please feel free to add:
Reviewed-by: Paul E. McKenney <paulmck@kernel.org>
And let me know so that I can drop my version.
Thanx, Paul
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-05-18 16:48 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-04 12:35 [PATCH] rcu: fix some kernel-doc warnings Mauro Carvalho Chehab
2020-05-18 16:48 ` Paul E. McKenney
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).