linux-kernel - Re: [PATCH 15/30] iio: dummy: iio_dummy_evgen: Demote file header and supply description for 'irq_sim

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: <20200917193206.40f68d76@archlinux>
Date:   Thu, 17 Sep 2020 19:32:06 +0100
From:   Jonathan Cameron <jic23@...23.retrosnub.co.uk>
To:     Bartosz Golaszewski <bgolaszewski@...libre.com>
Cc:     Lee Jones <lee.jones@...aro.org>, Hartmut Knaack <knaack.h@....de>,
        Lars-Peter Clausen <lars@...afoo.de>,
        Peter Meerwald-Stadler <pmeerw@...erw.net>,
        arm-soc <linux-arm-kernel@...ts.infradead.org>,
        LKML <linux-kernel@...r.kernel.org>,
        linux-iio <linux-iio@...r.kernel.org>,
        Marc Zyngier <maz@...nel.org>
Subject: Re: [PATCH 15/30] iio: dummy: iio_dummy_evgen: Demote file header
 and supply description for 'irq_sim_domain'

On Sat, 18 Jul 2020 16:00:46 +0100
Jonathan Cameron <jic23@...nel.org> wrote:

> On Sat, 18 Jul 2020 11:24:40 +0200
> Bartosz Golaszewski <bgolaszewski@...libre.com> wrote:
> 
> > On Thu, Jul 16, 2020 at 3:59 PM Lee Jones <lee.jones@...aro.org> wrote:  
> > >
> > > File headers are not good candidates for kerneldoc.
> > >
> > > Fixes the following W=1 kernel build warning(s):
> > >
> > >  drivers/iio/dummy/iio_dummy_evgen.c:30: warning: Cannot understand  * @regs: irq regs we are faking
> > >  on line 30 - I thought it was a doc line
> > >  drivers/iio/dummy/iio_dummy_evgen.c:42: warning: Function parameter or member 'irq_sim_domain' not described in 'iio_dummy_eventgen'
> > >
> > > Cc: Marc Zyngier <maz@...nel.org>
> > > Cc: Bartosz Golaszewski <bgolaszewski@...libre.com>
> > > Signed-off-by: Lee Jones <lee.jones@...aro.org>
> > > ---
> > >  drivers/iio/dummy/iio_dummy_evgen.c | 4 +++-
> > >  1 file changed, 3 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/drivers/iio/dummy/iio_dummy_evgen.c b/drivers/iio/dummy/iio_dummy_evgen.c
> > > index ee85d596e5284..1febbbff0ded6 100644
> > > --- a/drivers/iio/dummy/iio_dummy_evgen.c
> > > +++ b/drivers/iio/dummy/iio_dummy_evgen.c
> > > @@ -1,5 +1,5 @@
> > >  // SPDX-License-Identifier: GPL-2.0-only
> > > -/**
> > > +/*
> > >   * Copyright (c) 2011 Jonathan Cameron
> > >   *
> > >   * Companion module to the iio simple dummy example driver.
> > > @@ -27,11 +27,13 @@
> > >  #define IIO_EVENTGEN_NO 10
> > >
> > >  /**
> > > + * struct iio_dummy_eventgen  
> 
> Good to say what this structure is.  Perhaps "event generator specific state"
> 
> > >   * @regs: irq regs we are faking
> > >   * @lock: protect the evgen state
> > >   * @inuse: mask of which irqs are connected
> > >   * @irq_sim: interrupt simulator
> > >   * @base: base of irq range
> > > + * @irq_sim_domain: irq domain    
> > 
> > To be even more clear: this could say: "interrupt simulator domain".
> > 
> > Bartosz
Tweaked during applying and applied.
> >   
> > >   */
> > >  struct iio_dummy_eventgen {
> > >         struct iio_dummy_regs regs[IIO_EVENTGEN_NO];
> > > --
> > > 2.25.1
> > >    
>