2018-09-03 19:47:22

by Randy Dunlap

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

From: Randy Dunlap <[email protected]>

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 <[email protected]>
Cc: Lai Jiangshan <[email protected]>
Cc: "Paul E. McKenney" <[email protected]>
Cc: Josh Triplett <[email protected]>
Cc: Steven Rostedt <[email protected]>
Cc: Mathieu Desnoyers <[email protected]>
Cc: Joel Fernandes (Google) <[email protected]>
---
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)

2018-09-04 16:53:25

by Paul E. McKenney

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

On Mon, Sep 03, 2018 at 12:45:45PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <[email protected]>
>
> 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 <[email protected]>

Queued, thank you Randy!

Thanx, Paul

> Cc: Lai Jiangshan <[email protected]>
> Cc: "Paul E. McKenney" <[email protected]>
> Cc: Josh Triplett <[email protected]>
> Cc: Steven Rostedt <[email protected]>
> Cc: Mathieu Desnoyers <[email protected]>
> Cc: Joel Fernandes (Google) <[email protected]>
> ---
> 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)
>
>
>