rculist: Describe variadic macro argument in a Sphinx-compatible way (f452ee09) · Commits · 戴 / test

Without this patch, Sphinx shows "variable arguments" as the description of the cond argument, rather than the intended description, and prints the following warnings: ./include/linux/rculist.h:374: warning: Excess function parameter 'cond' description in 'list_for_each_entry_rcu' ./include/linux/rculist.h:651: warning: Excess function parameter 'cond' description in 'hlist_for_each_entry_rcu' Signed-off-by:

Jonathan Neuschäfer <j.neuschaefer@gmx.net> Acked-by:

Joel Fernandes (Google) <joel@joelfernandes.org> Signed-off-by:

Paul E. McKenney <paulmck@kernel.org>

include/linux/rculist.h

+2 −2

Original line number	Diff line number	Diff line
		@@ -361,7 +361,7 @@ static inline void list_splice_tail_init_rcu(struct list_head *list,
		* @pos: the type * to use as a loop cursor.
		* @head: the head for your list.
		* @member: the name of the list_head within the struct.
		* @cond: optional lockdep expression if called from non-RCU protection.
		* @cond...: optional lockdep expression if called from non-RCU protection.
		*
		* This list-traversal primitive may safely run concurrently with
		* the _rcu list-mutation primitives such as list_add_rcu()
		@@ -636,7 +636,7 @@ static inline void hlist_add_behind_rcu(struct hlist_node *n,
		* @pos: the type * to use as a loop cursor.
		* @head: the head for your list.
		* @member: the name of the hlist_node within the struct.
		* @cond: optional lockdep expression if called from non-RCU protection.
		* @cond...: optional lockdep expression if called from non-RCU protection.
		*
		* This list-traversal primitive may safely run concurrently with
		* the _rcu list-mutation primitives such as hlist_add_head_rcu()

Admin message