]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
rculist: Describe variadic macro argument in a Sphinx-compatible way
authorJonathan Neuschäfer <j.neuschaefer@gmx.net>
Fri, 4 Oct 2019 21:54:02 +0000 (23:54 +0200)
committerPaul E. McKenney <paulmck@kernel.org>
Mon, 9 Dec 2019 20:36:57 +0000 (12:36 -0800)
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

index 4158b72129369fb54e7a617362108039f68986a0..61c6728a71f74776e5a53c8781fda736a42371cc 100644 (file)
@@ -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()