| Message ID | 20230920092211.11371-2-pstanner@redhat.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 263fdb130587db939c65d198b53ffc6dba64fde1 |
| Headers | show |
| Series | rculist.h: docu: fix wrong function summary | expand |
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 >
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.
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(-)