mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Neeraj Upadhyay (AMD)" <neeraj.iitr10@gmail.com>
To: rcu@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, kernel-team@meta.com,
	rostedt@goodmis.org, paulmck@kernel.org, Neeraj.Upadhyay@amd.com,
	Philipp Stanner <pstanner@redhat.com>,
	Neeraj Upadhyay <neeraj.iitr10@gmail.com>
Subject: [PATCH rcu 2/5] rculist.h: docs: Fix wrong function summary
Date: Tue, 12 Dec 2023 22:56:50 +0530	[thread overview]
Message-ID: <20231212172653.11485-2-neeraj.iitr10@gmail.com> (raw)
In-Reply-To: <20231212172343.GA11383@neeraj.linux>

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 --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.
-- 
2.40.1


  parent reply	other threads:[~2023-12-12 17:27 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-12 17:23 [PATCH rcu 0/5] Documentation updates for v6.8 Neeraj Upadhyay (AMD)
2023-12-12 17:26 ` [PATCH rcu 1/5] Documentation: RCU: Remove repeated word in comments Neeraj Upadhyay (AMD)
2023-12-12 17:26 ` Neeraj Upadhyay (AMD) [this message]
2023-12-12 17:26 ` [PATCH rcu 3/5] doc: Clarify RCU Tasks reader/updater checklist Neeraj Upadhyay (AMD)
2023-12-12 20:09   ` Joel Fernandes
2023-12-12 17:26 ` [PATCH rcu 4/5] doc: Mention address and data dependencies in rcu_dereference.rst Neeraj Upadhyay (AMD)
2023-12-12 17:26 ` [PATCH rcu 5/5] doc: Clarify historical disclaimers in memory-barriers.txt Neeraj Upadhyay (AMD)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231212172653.11485-2-neeraj.iitr10@gmail.com \
    --to=neeraj.iitr10@gmail.com \
    --cc=Neeraj.Upadhyay@amd.com \
    --cc=kernel-team@meta.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=paulmck@kernel.org \
    --cc=pstanner@redhat.com \
    --cc=rcu@vger.kernel.org \
    --cc=rostedt@goodmis.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®