From: "Paul E. McKenney" <paulmck@kernel.org>
To: Philipp Stanner <pstanner@redhat.com>
Cc: Frederic Weisbecker <frederic@kernel.org>,
Neeraj Upadhyay <quic_neeraju@quicinc.com>,
Joel Fernandes <joel@joelfernandes.org>,
Josh Triplett <josh@joshtriplett.org>,
Boqun Feng <boqun.feng@gmail.com>,
Steven Rostedt <rostedt@goodmis.org>,
Mathieu Desnoyers <mathieu.desnoyers@efficios.com>,
Lai Jiangshan <jiangshanlai@gmail.com>,
Zqiang <qiang.zhang1211@gmail.com>,
rcu@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] rculist.h: docu: fix wrong function summary
Date: Wed, 20 Sep 2023 03:56:03 -0700 [thread overview]
Message-ID: <3b99763c-4380-4550-8c21-66cb8c80cca6@paulmck-laptop> (raw)
In-Reply-To: <20230920092211.11371-2-pstanner@redhat.com>
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
>
prev parent reply other threads:[~2023-09-20 10:56 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-20 9:22 [PATCH] rculist.h: docu: fix wrong function summary Philipp Stanner
2023-09-20 10:56 ` Paul E. McKenney [this message]
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=3b99763c-4380-4550-8c21-66cb8c80cca6@paulmck-laptop \
--to=paulmck@kernel.org \
--cc=boqun.feng@gmail.com \
--cc=frederic@kernel.org \
--cc=jiangshanlai@gmail.com \
--cc=joel@joelfernandes.org \
--cc=josh@joshtriplett.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=pstanner@redhat.com \
--cc=qiang.zhang1211@gmail.com \
--cc=quic_neeraju@quicinc.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).