linux-kernel - Re: [PATCH 01/10] mfd: wm8350-core: Supply description wm8350_reg

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20200625065608.GB2789306@kroah.com>
Date:   Thu, 25 Jun 2020 08:56:08 +0200
From:   Greg KH <gregkh@...uxfoundation.org>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org,
        stable@...r.kernel.org, patches@...nsource.cirrus.com
Subject: Re: [PATCH 01/10] mfd: wm8350-core: Supply description
 wm8350_reg_{un}lock args

On Thu, Jun 25, 2020 at 07:46:10AM +0100, Lee Jones wrote:
> Kerneldoc syntax is used, but not complete.  Descriptions required.
> 
> Prevents warnings like:
> 
>  drivers/mfd/wm8350-core.c:136: warning: Function parameter or member 'wm8350' not described in 'wm8350_reg_lock'
>  drivers/mfd/wm8350-core.c:165: warning: Function parameter or member 'wm8350' not described in 'wm8350_reg_unlock'
> 
> Cc: <stable@...r.kernel.org>
> Cc: patches@...nsource.cirrus.com
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>  drivers/mfd/wm8350-core.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/mfd/wm8350-core.c b/drivers/mfd/wm8350-core.c
> index 42b16503e6cd1..fbc77b218215c 100644
> --- a/drivers/mfd/wm8350-core.c
> +++ b/drivers/mfd/wm8350-core.c
> @@ -131,6 +131,8 @@ EXPORT_SYMBOL_GPL(wm8350_block_write);
>   * The WM8350 has a hardware lock which can be used to prevent writes to
>   * some registers (generally those which can cause particularly serious
>   * problems if misused).  This function enables that lock.
> + *
> + * @wm8350: pointer to local driver data structure
>   */
>  int wm8350_reg_lock(struct wm8350 *wm8350)
>  {
> @@ -160,6 +162,8 @@ EXPORT_SYMBOL_GPL(wm8350_reg_lock);
>   * problems if misused).  This function disables that lock so updates
>   * can be performed.  For maximum safety this should be done only when
>   * required.
> + *
> + * @wm8350: pointer to local driver data structure
>   */
>  int wm8350_reg_unlock(struct wm8350 *wm8350)
>  {
> -- 
> 2.25.1
> 

Why are all of these documentation fixes for stable?