From: "Paul E. McKenney" <paulmck@kernel.org>
To: madhuparnabhowmik04@gmail.com
Cc: joel@joelfernandes.org, rcu@vger.kernel.org,
linux-kernel@vger.kernel.org,
linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [PATCH] Include: Linux: rculist_nulls: Add docbook comment headers
Date: Wed, 4 Dec 2019 16:25:18 -0800 [thread overview]
Message-ID: <20191205002518.GP2889@paulmck-ThinkPad-P72> (raw)
In-Reply-To: <20191204120357.11658-1-madhuparnabhowmik04@gmail.com>
On Wed, Dec 04, 2019 at 05:33:57PM +0530, madhuparnabhowmik04@gmail.com wrote:
> From: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
>
> This patch adds docbook comment headers for hlist_nulls_first_rcu
> and hlist_nulls_next_rcu in rculist_nulls.h.
>
> Signed-off-by: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
> ---
Good to see, thank you! A few grammar nits below -- could you please
update and re-send?
Thanx, Paul
> include/linux/rculist_nulls.h | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/include/linux/rculist_nulls.h b/include/linux/rculist_nulls.h
> index 517a06f36c7a..d796ef18ec52 100644
> --- a/include/linux/rculist_nulls.h
> +++ b/include/linux/rculist_nulls.h
> @@ -38,9 +38,17 @@ static inline void hlist_nulls_del_init_rcu(struct hlist_nulls_node *n)
> }
> }
>
> +/**
> + * hlist_nulls_first_rcu - returns the first element of the hash list.
> + * @head: the head for your list.
Could you please say something like "The head of the list."?
Just to keep point of view more consistent through the documentation.
> + */
> #define hlist_nulls_first_rcu(head) \
> (*((struct hlist_nulls_node __rcu __force **)&(head)->first))
>
> +/**
> + * hlist_nulls_next_rcu - returns the element of the list next to @node.
Here, could you please change "next to" to "after"? This removes the
ambiguity where both the prior and the subsequent elements might be
thought of as "next to".
> + * @node: Element of the list.
> + */
> #define hlist_nulls_next_rcu(node) \
> (*((struct hlist_nulls_node __rcu __force **)&(node)->next))
>
> --
> 2.17.1
>
next prev parent reply other threads:[~2019-12-05 0:25 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-04 12:03 [PATCH] Include: Linux: rculist_nulls: Add docbook comment headers madhuparnabhowmik04
2019-12-04 17:44 ` Joel Fernandes
2019-12-05 0:25 ` Paul E. McKenney [this message]
[not found] ` <CAF65HP1WL2yw8nVZi-j9=eehkUJP-eKUy+w9unFXddmPf7_Hqg@mail.gmail.com>
2019-12-05 14:42 ` Paul E. McKenney
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=20191205002518.GP2889@paulmck-ThinkPad-P72 \
--to=paulmck@kernel.org \
--cc=joel@joelfernandes.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=madhuparnabhowmik04@gmail.com \
--cc=rcu@vger.kernel.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 NNTP newsgroup(s).