linux-arm-kernel.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: "Heiko Stübner" <heiko@sntech.de>
Cc: linux-kernel@vger.kernel.org, Max Schwarz <max.schwarz@online.de>,
	linux-arm-kernel@lists.infradead.org,
	linux-rockchip@lists.infradead.org, linux-i2c@vger.kernel.org
Subject: Re: [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones
Date: Fri, 21 May 2021 07:56:14 +0100	[thread overview]
Message-ID: <20210521065614.GO2549456@dell> (raw)
In-Reply-To: <6083609.GXAFRqVoOG@diego>

On Thu, 20 May 2021, Heiko Stübner wrote:

> Hi Lee,
> 
> Am Donnerstag, 20. Mai 2021, 21:01:01 CEST schrieb Lee Jones:
> > Fixes the following W=1 kernel build warning(s):
> > 
> >  drivers/i2c/busses/i2c-rk3x.c:242: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  drivers/i2c/busses/i2c-rk3x.c:261: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  drivers/i2c/busses/i2c-rk3x.c:304: warning: Function parameter or member 'i2c' not described in 'rk3x_i2c_prepare_read'
> >  drivers/i2c/busses/i2c-rk3x.c:304: warning: expecting prototype for Setup a read according to i2c(). Prototype was for rk3x_i2c_prepare_read() instead
> >  drivers/i2c/busses/i2c-rk3x.c:335: warning: Function parameter or member 'i2c' not described in 'rk3x_i2c_fill_transmit_buf'
> >  drivers/i2c/busses/i2c-rk3x.c:335: warning: expecting prototype for Fill the transmit buffer with data from i2c(). Prototype was for rk3x_i2c_fill_transmit_buf() instead
> >  drivers/i2c/busses/i2c-rk3x.c:535: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  drivers/i2c/busses/i2c-rk3x.c:552: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  drivers/i2c/busses/i2c-rk3x.c:713: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  drivers/i2c/busses/i2c-rk3x.c:963: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> >  drivers/i2c/busses/i2c-rk3x.c:973: warning: Function parameter or member 'i2c' not described in 'rk3x_i2c_setup'
> > 
> > Cc: Heiko Stuebner <heiko@sntech.de>
> > Cc: Max Schwarz <max.schwarz@online.de>
> > Cc: linux-arm-kernel@lists.infradead.org
> > Cc: linux-rockchip@lists.infradead.org
> > Cc: linux-i2c@vger.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> >  drivers/i2c/busses/i2c-rk3x.c | 18 +++++++++---------
> >  1 file changed, 9 insertions(+), 9 deletions(-)
> > 
> > diff --git a/drivers/i2c/busses/i2c-rk3x.c b/drivers/i2c/busses/i2c-rk3x.c
> > index 819ab4ee517e1..1dfbd1185aefc 100644
> > --- a/drivers/i2c/busses/i2c-rk3x.c
> > +++ b/drivers/i2c/busses/i2c-rk3x.c
> > @@ -238,7 +238,7 @@ static inline void rk3x_i2c_clean_ipd(struct rk3x_i2c *i2c)
> >  	i2c_writel(i2c, REG_INT_ALL, REG_IPD);
> >  }
> >  
> > -/**
> > +/*
> >   * Generate a START condition, which triggers a REG_INT_START interrupt.
> >   */
> >  static void rk3x_i2c_start(struct rk3x_i2c *i2c)
> > @@ -257,7 +257,7 @@ static void rk3x_i2c_start(struct rk3x_i2c *i2c)
> >  	i2c_writel(i2c, val, REG_CON);
> >  }
> >  
> > -/**
> > +/*
> >   * Generate a STOP condition, which triggers a REG_INT_STOP interrupt.
> 
> what made you decide between demoting and completing comments?
> I.e. here you demot the "static void rk3x_i2c_stop()", while below
> you for example complete the "static rk3x_i2c_get_spec()".
> 
> So I somehow do not yet see the pattern ;-)

Completeness.  This one is missing parameter descriptions, the one I
provided the function name to below, is otherwise complete.

-- 
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:[~2021-05-21  6:58 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20210520190105.3772683-1-lee.jones@linaro.org>
2021-05-20 19:00 ` [PATCH 01/16] i2c: busses: i2c-nomadik: Fix formatting issue pertaining to 'timeout' Lee Jones
2021-05-27  0:21   ` Linus Walleij
2021-05-27 19:28   ` Wolfram Sang
2021-05-28  7:58     ` Lee Jones
2021-05-28  8:00       ` Wolfram Sang
2021-05-28  8:17         ` Lee Jones
2021-05-20 19:00 ` [PATCH 06/16] i2c: busses: i2c-cadence: Fix incorrectly documented 'enum cdns_i2c_slave_mode' Lee Jones
2021-05-24  6:49   ` Michal Simek
2021-05-20 19:00 ` [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header Lee Jones
2021-06-03 20:29   ` Wolfram Sang
2021-06-04  8:47     ` Lee Jones
2021-06-04  9:06       ` Wolfram Sang
2021-06-04  9:32         ` Lee Jones
2021-05-20 19:01 ` [PATCH 11/16] i2c: busses: i2c-pnx: Provide descriptions for 'alg_data' data structure Lee Jones
2021-05-21  6:24   ` Vladimir Zapolskiy
2021-05-20 19:01 ` [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones Lee Jones
2021-05-20 21:52   ` Heiko Stübner
2021-05-21  6:56     ` Lee Jones [this message]
2021-06-19 22:07   ` Heiko Stuebner
2021-05-20 19:01 ` [PATCH 13/16] i2c: busses: i2c-st: Fix copy/paste function misnaming issues Lee Jones
2021-05-21 14:17   ` Alain Volmat
2021-05-21 14:23     ` Alain Volmat
2021-05-27 19:35   ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 14/16] i2c: busses: i2c-stm32f4: Remove incorrectly placed ' ' from function name Lee Jones
2021-05-21 14:20   ` Alain Volmat
2021-05-27 19:35   ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 16/16] i2c: busses: i2c-st: trivial: Fix spelling issue 'enmpty => empty' Lee Jones
2021-05-21 14:23   ` Alain Volmat
2021-05-27 19:38     ` Wolfram Sang

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=20210521065614.GO2549456@dell \
    --to=lee.jones@linaro.org \
    --cc=heiko@sntech.de \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-i2c@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-rockchip@lists.infradead.org \
    --cc=max.schwarz@online.de \
    --subject='Re: [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones' \
    /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

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).