diff mbox series

[2/5] rculist.h: docs: Fix wrong function summary

Message ID 20231212172653.11485-2-neeraj.iitr10@gmail.com (mailing list archive)
State Accepted
Commit 493dffa3ab07b5d2c0b7bd5de5bff6e85f01f52a
Headers show
Series Documentation updates for v6.8 | expand

Commit Message

Neeraj upadhyay Dec. 12, 2023, 5:26 p.m. UTC 
From: Philipp Stanner <pstanner@redhat.com>

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>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Signed-off-by: Neeraj Upadhyay (AMD) <neeraj.iitr10@gmail.com>
---
 include/linux/rculist.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/linux/rculist.h b/include/linux/rculist.h
index d29740be4833..3dc1e58865f7 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.