linux-kernel - Re: [PATCH 06/30] iio: adc: ad7923: Demote obvious misuse of kerneldoc to standard comment blocks

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: <20200718153525.24e68167@archlinux>
Date:   Sat, 18 Jul 2020 15:35:25 +0100
From:   Jonathan Cameron <jic23@...nel.org>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     knaack.h@....de, lars@...afoo.de, pmeerw@...erw.net,
        linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org,
        linux-iio@...r.kernel.org,
        Michael Hennerich <Michael.Hennerich@...log.com>,
        Patrick Vasseur <patrick.vasseur@....fr>
Subject: Re: [PATCH 06/30] iio: adc: ad7923: Demote obvious misuse of
 kerneldoc to standard comment blocks

On Thu, 16 Jul 2020 14:59:04 +0100
Lee Jones <lee.jones@...aro.org> wrote:

> No attempt has been made to document either of the demoted functions here
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/iio/adc/ad7923.c:159: warning: Function parameter or member 'indio_dev' not described in 'ad7923_update_scan_mode'
>  drivers/iio/adc/ad7923.c:159: warning: Function parameter or member 'active_scan_mask' not described in 'ad7923_update_scan_mode'
>  drivers/iio/adc/ad7923.c:202: warning: Function parameter or member 'irq' not described in 'ad7923_trigger_handler'
>  drivers/iio/adc/ad7923.c:202: warning: Function parameter or member 'p' not described in 'ad7923_trigger_handler'
> 
> Cc: Michael Hennerich <Michael.Hennerich@...log.com>
> Cc: Patrick Vasseur <patrick.vasseur@....fr>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
Both functions are static and hence don't need to be kernel-doc based,
hence agree this is the best 'fix'.

Applied to the togreg branch of iio.git and pushed out as testing for
the autobuilders to play with it.

Thanks,

Jonathan

> ---
>  drivers/iio/adc/ad7923.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/iio/adc/ad7923.c b/drivers/iio/adc/ad7923.c
> index 1d124c87c6ace..2a11bc7fdb567 100644
> --- a/drivers/iio/adc/ad7923.c
> +++ b/drivers/iio/adc/ad7923.c
> @@ -151,9 +151,9 @@ static const struct ad7923_chip_info ad7923_chip_info[] = {
>  	},
>  };
>  
> -/**
> +/*
>   * ad7923_update_scan_mode() setup the spi transfer buffer for the new scan mask
> - **/
> + */
>  static int ad7923_update_scan_mode(struct iio_dev *indio_dev,
>  				   const unsigned long *active_scan_mask)
>  {
> @@ -192,12 +192,12 @@ static int ad7923_update_scan_mode(struct iio_dev *indio_dev,
>  	return 0;
>  }
>  
> -/**
> +/*
>   * ad7923_trigger_handler() bh of trigger launched polling to ring buffer
>   *
>   * Currently there is no option in this driver to disable the saving of
>   * timestamps within the ring.
> - **/
> + */
>  static irqreturn_t ad7923_trigger_handler(int irq, void *p)
>  {
>  	struct iio_poll_func *pf = p;