linux-kernel - Re: [PATCH 28/30] iio: magnetometer: mmc35240: Fix function header formatting

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: <20200718161640.70fce581@archlinux>
Date:   Sat, 18 Jul 2020 16:16:40 +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, Daniel Baluta <daniel.baluta@...el.com>
Subject: Re: [PATCH 28/30] iio: magnetometer: mmc35240: Fix function header
 formatting

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

> All lines in the header must start with " *".
> 
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/iio/magnetometer/mmc35240.c:304: warning: bad line:                             compensation for output value.
> 
> Cc: Daniel Baluta <daniel.baluta@...el.com>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
I tweaked this one a tiny bit to drop the brackets you added.
I remember looking this up recently and they are optional in the kernel-doc
format.  Adds a very small amount of confusion perhaps to add them in here.

Applied


> ---
>  drivers/iio/magnetometer/mmc35240.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/iio/magnetometer/mmc35240.c b/drivers/iio/magnetometer/mmc35240.c
> index 1787d656d0094..19e46b1f4ee81 100644
> --- a/drivers/iio/magnetometer/mmc35240.c
> +++ b/drivers/iio/magnetometer/mmc35240.c
> @@ -300,8 +300,8 @@ static int mmc35240_read_measurement(struct mmc35240_data *data, __le16 buf[3])
>  }
>  
>  /**
> - * mmc35240_raw_to_mgauss - convert raw readings to milli gauss. Also apply
> -			    compensation for output value.
> + * mmc35240_raw_to_mgauss() - convert raw readings to milli gauss. Also apply
> + *			      compensation for output value.
>   *
>   * @data: device private data
>   * @index: axis index for which we want the conversion