History

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'

Jonathan Neuschäfer committed 7 years ago

Commit f452ee01 parent e42617b1 file · +2 −2Browse files

Showing the changes to include/linux (1 of 1 file). Show all

Unified · Split

include/linux/rculist.h+2−2
@@ -361,7 +361,7 @@ static inline void list_splice_tail_init_rcu(struct list_head *list, · 360 unmodified lines
361361 * @pos: the type * to use as a loop cursor.
362362 * @head: the head for your list.
363363 * @member: the name of the list_head within the struct.
364− * @cond: optional lockdep expression if called from non-RCU protection.
364+ * @cond...: optional lockdep expression if called from non-RCU protection.
365365 *
366366 * This list-traversal primitive may safely run concurrently with
367367 * 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, · 268 unmodified lines
636636 * @pos: the type * to use as a loop cursor.
637637 * @head: the head for your list.
638638 * @member: the name of the hlist_node within the struct.
639− * @cond: optional lockdep expression if called from non-RCU protection.
639+ * @cond...: optional lockdep expression if called from non-RCU protection.
640640 *
641641 * This list-traversal primitive may safely run concurrently with
642642 * the _rcu list-mutation primitives such as hlist_add_head_rcu()

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t