[PATCH tip/core/rcu 08/16] doc: Add parameters to rcupdate.h docbook comments

From: Paul E. McKenney
Date: Wed Oct 04 2017 - 17:23:32 EST


Signed-off-by: Paul E. McKenney <paulmck@xxxxxxxxxxxxxxxxxx>
---
include/linux/rcupdate.h | 4 ++++
1 file changed, 4 insertions(+)

diff --git a/include/linux/rcupdate.h b/include/linux/rcupdate.h
index de50d8a4cf41..77f2e136bf81 100644
--- a/include/linux/rcupdate.h
+++ b/include/linux/rcupdate.h
@@ -778,6 +778,8 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)

/**
* RCU_INIT_POINTER() - initialize an RCU protected pointer
+ * @p: The pointer to be initialized.
+ * @v: The value to initialized the pointer to.
*
* Initialize an RCU-protected pointer in special cases where readers
* do not need ordering constraints on the CPU or the compiler. These
@@ -819,6 +821,8 @@ static inline notrace void rcu_read_unlock_sched_notrace(void)

/**
* RCU_POINTER_INITIALIZER() - statically initialize an RCU protected pointer
+ * @p: The pointer to be initialized.
+ * @v: The value to initialized the pointer to.
*
* GCC-style initialization for an RCU-protected pointer in a structure field.
*/
--
2.5.2