Re: [PATCH] srcu: fix kernel-doc missing notation

From: Paul E. McKenney
Date: Tue Sep 04 2018 - 12:52:06 EST


On Mon, Sep 03, 2018 at 12:45:45PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Fix kernel-doc warnings for missing parameter descriptions:
>
> ../include/linux/srcu.h:175: warning: Function parameter or member 'p' not described in 'srcu_dereference_notrace'
> ../include/linux/srcu.h:175: warning: Function parameter or member 'sp' not described in 'srcu_dereference_notrace'
>
> Fixes: 0b764a6e4e19d ("srcu: Add notrace variant of srcu_dereference")
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Queued, thank you Randy!

Thanx, Paul

> Cc: Lai Jiangshan <jiangshanlai@xxxxxxxxx>
> Cc: "Paul E. McKenney" <paulmck@xxxxxxxxxxxxxxxxxx>
> Cc: Josh Triplett <josh@xxxxxxxxxxxxxxxx>
> Cc: Steven Rostedt <rostedt@xxxxxxxxxxx>
> Cc: Mathieu Desnoyers <mathieu.desnoyers@xxxxxxxxxxxx>
> Cc: Joel Fernandes (Google) <joel@xxxxxxxxxxxxxxxxx>
> ---
> include/linux/srcu.h | 3 +++
> 1 file changed, 3 insertions(+)
>
> --- lnx-419-rc2.orig/include/linux/srcu.h
> +++ lnx-419-rc2/include/linux/srcu.h
> @@ -171,6 +171,9 @@ static inline int srcu_read_lock_held(co
>
> /**
> * srcu_dereference_notrace - no tracing and no lockdep calls from here
> + * @p: the pointer to fetch and protect for later dereferencing
> + * @sp: pointer to the srcu_struct, which is used to check that we
> + * really are in an SRCU read-side critical section.
> */
> #define srcu_dereference_notrace(p, sp) srcu_dereference_check((p), (sp), 1)
>
>
>