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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Tue, 4 Sep 2018 09:52:00 -0700
From:   "Paul E. McKenney" <paulmck@...ux.vnet.ibm.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     LKML <linux-kernel@...r.kernel.org>,
        Lai Jiangshan <jiangshanlai@...il.com>,
        Josh Triplett <josh@...htriplett.org>,
        Steven Rostedt <rostedt@...dmis.org>,
        Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
        "Joel Fernandes (Google)" <joel@...lfernandes.org>
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 <rdunlap@...radead.org>
> 
> 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@...radead.org>

Queued, thank you Randy!

							Thanx, Paul

> Cc: Lai Jiangshan <jiangshanlai@...il.com>
> Cc: "Paul E. McKenney" <paulmck@...ux.vnet.ibm.com>
> Cc: Josh Triplett <josh@...htriplett.org>
> Cc: Steven Rostedt <rostedt@...dmis.org>
> Cc: Mathieu Desnoyers <mathieu.desnoyers@...icios.com>
> Cc: Joel Fernandes (Google) <joel@...lfernandes.org>
> ---
>  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)
> 
> 
>