diff options
author | Jonathan Neuschäfer <j.neuschaefer@gmx.net> | 2019-10-04 23:54:02 +0200 |
---|---|---|
committer | Paul E. McKenney <paulmck@kernel.org> | 2019-12-09 12:36:57 -0800 |
commit | f452ee096d95482892b101bde4fd037fa025d3cc (patch) | |
tree | 2ced7c926ecf1dad173d56647cdc0bedf7b300c8 | |
parent | e42617b825f8073569da76dc4510bfa019b1c35a (diff) | |
download | linux-f452ee096d95482892b101bde4fd037fa025d3cc.tar.gz linux-f452ee096d95482892b101bde4fd037fa025d3cc.tar.bz2 linux-f452ee096d95482892b101bde4fd037fa025d3cc.zip |
rculist: Describe variadic macro argument in a Sphinx-compatible way
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>
-rw-r--r-- | include/linux/rculist.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/linux/rculist.h b/include/linux/rculist.h index 4158b7212936..61c6728a71f7 100644 --- a/include/linux/rculist.h +++ b/include/linux/rculist.h @@ -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() |