* [PATCH] rculist.h: docu: fix wrong function summary
@ 2023-09-20 9:22 Philipp Stanner
2023-09-20 10:56 ` Paul E. McKenney
0 siblings, 1 reply; 2+ messages in thread
From: Philipp Stanner @ 2023-09-20 9:22 UTC (permalink / raw)
To: Paul E. McKenney, Frederic Weisbecker, Neeraj Upadhyay,
Joel Fernandes, Josh Triplett, Boqun Feng, Steven Rostedt,
Mathieu Desnoyers, Lai Jiangshan, Zqiang
Cc: rcu, linux-kernel, Philipp Stanner
The brief summary in the docstring for function list_next_or_null_rcu()
states that the function is supposed to provide the "first" member of a
list, whereas in truth it returns the next member.
Change the docstring so it describes what the function actually does.
Signed-off-by: Philipp Stanner <pstanner@redhat.com>
---
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 4837d8892691..fd0ed1550a7c 100644
--- a/include/linux/rculist.h
+++ b/include/linux/rculist.h
@@ -355,7 +355,7 @@ static inline void list_splice_tail_init_rcu(struct list_head *list,
})
/**
- * list_next_or_null_rcu - get the first element from a list
+ * list_next_or_null_rcu - get the next element from a list
* @head: the head for the list.
* @ptr: the list head to take the next element from.
* @type: the type of the struct this is embedded in.
--
2.41.0
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] rculist.h: docu: fix wrong function summary
2023-09-20 9:22 [PATCH] rculist.h: docu: fix wrong function summary Philipp Stanner
@ 2023-09-20 10:56 ` Paul E. McKenney
0 siblings, 0 replies; 2+ messages in thread
From: Paul E. McKenney @ 2023-09-20 10:56 UTC (permalink / raw)
To: Philipp Stanner
Cc: Frederic Weisbecker, Neeraj Upadhyay, Joel Fernandes,
Josh Triplett, Boqun Feng, Steven Rostedt, Mathieu Desnoyers,
Lai Jiangshan, Zqiang, rcu, linux-kernel
On Wed, Sep 20, 2023 at 11:22:12AM +0200, Philipp Stanner wrote:
> The brief summary in the docstring for function list_next_or_null_rcu()
> states that the function is supposed to provide the "first" member of a
> list, whereas in truth it returns the next member.
>
> Change the docstring so it describes what the function actually does.
>
> Signed-off-by: Philipp Stanner <pstanner@redhat.com>
Queued and pushed, thank you!
Thanx, Paul
> ---
> 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 4837d8892691..fd0ed1550a7c 100644
> --- a/include/linux/rculist.h
> +++ b/include/linux/rculist.h
> @@ -355,7 +355,7 @@ static inline void list_splice_tail_init_rcu(struct list_head *list,
> })
>
> /**
> - * list_next_or_null_rcu - get the first element from a list
> + * list_next_or_null_rcu - get the next element from a list
> * @head: the head for the list.
> * @ptr: the list head to take the next element from.
> * @type: the type of the struct this is embedded in.
> --
> 2.41.0
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-09-20 10:56 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-09-20 9:22 [PATCH] rculist.h: docu: fix wrong function summary Philipp Stanner
2023-09-20 10:56 ` 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
Powered by JetHome