linux-kernel - Re: [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones

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 for Android: free password hash cracker in your pocket

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

Date:   Fri, 21 May 2021 07:56:14 +0100
From:   Lee Jones <lee.jones@...aro.org>
To:     Heiko Stübner <heiko@...ech.de>
Cc:     linux-kernel@...r.kernel.org, Max Schwarz <max.schwarz@...ine.de>,
        linux-arm-kernel@...ts.infradead.org,
        linux-rockchip@...ts.infradead.org, linux-i2c@...r.kernel.org
Subject: Re: [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and
 help more complete ones

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@...ech.de>
> > Cc: Max Schwarz <max.schwarz@...ine.de>
> > Cc: linux-arm-kernel@...ts.infradead.org
> > Cc: linux-rockchip@...ts.infradead.org
> > Cc: linux-i2c@...r.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@...aro.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