On Thu, Jun 25, 2020 at 08:13:13AM +0100, Lee Jones wrote:
> 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@xxxxxxxxxxxxxxx>
> > > Cc: patches@xxxxxxxxxxxxxxxxxxxxx
> > > Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> > > ---
> > > 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.
When you type 'make' these warnings show up? We don't do documentation
builds as part of a normal build...
If for some reason we ever get rid of all of the thousands of current
warnings, then yes, I will be glad to consider stuff like this then.
thanks,
greg k-h
