linux-arm-kernel.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: Greg KH <gregkh@linuxfoundation.org>
Cc: stable@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	patches@opensource.cirrus.com
Subject: Re: [PATCH 01/10] mfd: wm8350-core: Supply description wm8350_reg_{un}lock args
Date: Thu, 25 Jun 2020 08:13:13 +0100	[thread overview]
Message-ID: <20200625071313.GM954398@dell> (raw)
In-Reply-To: <20200625065608.GB2789306@kroah.com>

On Thu, 25 Jun 2020, Greg KH wrote:

> 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@vger.kernel.org>
> > Cc: patches@opensource.cirrus.com
> > Signed-off-by: Lee Jones <lee.jones@linaro.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)
> >  {
> 
> Why are all of these documentation fixes for stable?

Because they fix compiler warnings.

Not correct?

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  reply	other threads:[~2020-06-25  7:15 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-25  6:46 [PATCH 00/10] Fix a bunch more W=1 warnings in MFD Lee Jones
2020-06-25  6:46 ` [PATCH 01/10] mfd: wm8350-core: Supply description wm8350_reg_{un}lock args Lee Jones
2020-06-25  6:56   ` Greg KH
2020-06-25  7:13     ` Lee Jones [this message]
2020-06-25  9:45       ` Greg KH
2020-06-25 13:34         ` Lee Jones
2020-06-25 13:24       ` Jonathan Corbet
2020-06-25 13:38         ` Lee Jones
2020-06-25  6:46 ` [PATCH 02/10] mfd: mfd-core: Complete kerneldoc header for devm_mfd_add_devices() Lee Jones
2020-07-01 19:33   ` Sasha Levin
2020-07-02  6:36     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin
2020-06-25  6:46 ` [PATCH 03/10] mfd: db8500-prcmu: Add description for 'reset_reason' in kerneldoc Lee Jones
2020-07-07 12:39   ` Linus Walleij
2020-06-25  6:46 ` [PATCH 04/10] mfd: db8500-prcmu: Remove incorrect function header from .probe() function Lee Jones
2020-07-07 12:39   ` Linus Walleij
2020-06-25  6:46 ` [PATCH 05/10] mfd: omap-usb-host: Remove invalid use of kerneldoc syntax Lee Jones
2020-06-25  6:46 ` [PATCH 06/10] mfd: omap-usb-host: Provide description for 'pdev' argument to .probe() Lee Jones
2020-06-25  6:46 ` [PATCH 07/10] mfd: omap-usb-tll: " Lee Jones
2020-06-25  6:46 ` [PATCH 08/10] mfd: atmel-smc: Silence comparison of unsigned expression < 0 is always false warning (W=1) Lee Jones
2020-06-26 20:56   ` Alexandre Belloni
2020-06-30 12:10     ` Lee Jones
2020-06-25  6:46 ` [PATCH 09/10] mfd: atmel-smc: Add missing colon(s) for 'conf' arguments Lee Jones
2020-06-25  6:55   ` Greg KH
2020-06-26 20:56   ` Alexandre Belloni
2020-07-01 19:33   ` Sasha Levin
2020-07-02  6:36     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin
2020-06-25  6:46 ` [PATCH 10/10] mfd: altera-sysmgr: Supply descriptions for 'np' and 'property' function args Lee Jones
2020-07-01 19:33   ` Sasha Levin
2020-07-02  6:35     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200625071313.GM954398@dell \
    --to=lee.jones@linaro.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=patches@opensource.cirrus.com \
    --cc=stable@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).