* [tip: core/rcu] rculist: Describe variadic macro argument in a Sphinx-compatible way
@ 2020-01-25 10:42 tip-bot2 for Jonathan Neuschäfer
0 siblings, 0 replies; only message in thread
From: tip-bot2 for Jonathan Neuschäfer @ 2020-01-25 10:42 UTC (permalink / raw)
To: linux-tip-commits
Cc: j.neuschaefer, Joel Fernandes (Google), Paul E. McKenney, x86, LKML
The following commit has been merged into the core/rcu branch of tip:
Commit-ID: f452ee096d95482892b101bde4fd037fa025d3cc
Gitweb: https://git.kernel.org/tip/f452ee096d95482892b101bde4fd037fa025d3cc
Author: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
AuthorDate: Fri, 04 Oct 2019 23:54:02 +02:00
Committer: Paul E. McKenney <paulmck@kernel.org>
CommitterDate: Mon, 09 Dec 2019 12:36:57 -08:00
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>
---
include/linux/rculist.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/include/linux/rculist.h b/include/linux/rculist.h
index 4158b72..61c6728 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()
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2020-01-25 10:45 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-01-25 10:42 [tip: core/rcu] rculist: Describe variadic macro argument in a Sphinx-compatible way tip-bot2 for Jonathan Neuschäfer
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).