[PATCH] Include: Linux: rculist_nulls: Add docbook comment headers

[PATCH] Include: Linux: rculist_nulls: Add docbook comment headers

[madhuparnabhowmik04]

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>
---
 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.
+ */
 #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.
+ * @node: Element of the list.
+ */
 #define hlist_nulls_next_rcu(node) \
 	(*((struct hlist_nulls_node __rcu __force **)&(node)->next))
 
-- 
2.17.1

Re: [PATCH] Include: Linux: rculist_nulls: Add docbook comment headers

[Joel Fernandes]

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>

Thanks. Could you send this to the list? I'd like Paul to review or apply
this one.

 - Joel

> ---
>  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.
> + */
>  #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.
> + * @node: Element of the list.
> + */
>  #define hlist_nulls_next_rcu(node) \
>  	(*((struct hlist_nulls_node __rcu __force **)&(node)->next))
>  
> -- 
> 2.17.1
> 

Re: [PATCH] Include: Linux: rculist_nulls: Add docbook comment headers

[Paul E. McKenney]

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
> 

Re: [PATCH] Include: Linux: rculist_nulls: Add docbook comment headers

[Paul E. McKenney]

On Thu, Dec 05, 2019 at 11:25:39AM +0530, Madhuparna Bhowmik wrote:
> On Thu, Dec 5, 2019 at 5:55 AM Paul E. McKenney <paulmck@kernel.org> wrote:
> 
> > 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?
> >
> > Thank you, I will send the updated patch soon.
> 
> 
> >                                                         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.
> >
> > Sure, I will change it to "head of the list".
> Moreover, in the rest of the docbook comments in the same file
> (rculist_nulls.h), "head for your list" is used.
> So, should I change that as well in a separate patch, such that it is
> consistent throughout the file?

Please do!

						Thanx, Paul

> > > + */
> > >  #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".
> >
> > Sure, I will do it. Thank you for pointing out.
> 
> Regards,
> Madhuparna
> 
> 
> > > + * @node: Element of the list.
> > > + */
> > >  #define hlist_nulls_next_rcu(node) \
> > >       (*((struct hlist_nulls_node __rcu __force **)&(node)->next))
> > >
> > > --
> > > 2.17.1
> > >
> >
> ᐧ