linux-kernel - Re: [PATCH 09/30] iio: dummy: iio_simple_dummy: Demote unworthy kerneldocs and correct misspelling

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: <20200718153910.71fcdb36@archlinux>
Date:   Sat, 18 Jul 2020 15:39:10 +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
Subject: Re: [PATCH 09/30] iio: dummy: iio_simple_dummy: Demote unworthy
 kerneldocs and correct misspelling

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

> File header comments are not good candidates for kerneldoc.  Neither
> are generic comment blocks.
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/iio/dummy/iio_simple_dummy.c:26: warning: cannot understand function prototype: 'const struct config_item_type iio_dummy_type = '
>  drivers/iio/dummy/iio_simple_dummy.c:564: warning: Function parameter or member 'name' not described in 'iio_dummy_probe'
>  drivers/iio/dummy/iio_simple_dummy.c:564: warning: Excess function parameter 'index' description in 'iio_dummy_probe'
>  drivers/iio/dummy/iio_simple_dummy.c:700: warning: cannot understand function prototype: 'const struct iio_sw_device_ops iio_dummy_device_ops = '
> 
Misspelling is an interesting way of describing that part.  I changed
it to "wrong parameter in docs".

Applied.

> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>  drivers/iio/dummy/iio_simple_dummy.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/iio/dummy/iio_simple_dummy.c b/drivers/iio/dummy/iio_simple_dummy.c
> index 6cb02299a2152..be66b26373723 100644
> --- a/drivers/iio/dummy/iio_simple_dummy.c
> +++ b/drivers/iio/dummy/iio_simple_dummy.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (c) 2011 Jonathan Cameron
>   *
>   * A reference industrial I/O driver to illustrate the functionality available.
> @@ -553,7 +553,7 @@ static int iio_dummy_init_device(struct iio_dev *indio_dev)
>  
>  /**
>   * iio_dummy_probe() - device instance probe
> - * @index: an id number for this instance.
> + * @name: name of this instance.
>   *
>   * Arguments are bus type specific.
>   * I2C: iio_dummy_probe(struct i2c_client *client,
> @@ -687,7 +687,7 @@ static int iio_dummy_remove(struct iio_sw_device *swd)
>  
>  	return 0;
>  }
> -/**
> +/*
>   * module_iio_sw_device_driver() -  device driver registration
>   *
>   * Varies depending on bus type of the device. As there is no device