linux-kernel - Re: [PATCH] iio: imu: adis: fix all kernel-doc warnings in header file

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: <aP8uOznzM-ixyRLJ@smile.fi.intel.com>
Date: Mon, 27 Oct 2025 10:32:59 +0200
From: Andy Shevchenko <andriy.shevchenko@...el.com>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Jonathan Cameron <jic23@...nel.org>,
	David Lechner <dlechner@...libre.com>,
	Nuno Sá <nuno.sa@...log.com>,
	Andy Shevchenko <andy@...nel.org>, linux-iio@...r.kernel.org
Subject: Re: [PATCH] iio: imu: adis: fix all kernel-doc warnings in header
 file

On Sat, Oct 25, 2025 at 07:47:59PM -0700, Randy Dunlap wrote:
> Correct and add to adis.h to resolve all kernel-doc warnings:
> 
> - add a missing struct member description
> - change one non-kernel-doc comment to use /* instead of /**
> - correct function parameter @value to @val (7 locations)
> - add function return value comments (13 locations)
> 
> Warning: include/linux/iio/imu/adis.h:97 struct member 'has_fifo'
>  not described in 'adis_data'
> Warning: include/linux/iio/imu/adis.h:139 Incorrect use of kernel-doc
>  format: * The state_lock is meant to be used during operations that
>  require
> Warning: include/linux/iio/imu/adis.h:158 struct member '"__adis_"'
>  not described in 'adis'
> Warning: include/linux/iio/imu/adis.h:264 function parameter 'val'
>  not described in 'adis_write_reg'
> Warning: include/linux/iio/imu/adis.h:371 No description found for
>  return value of 'adis_update_bits_base'

Thanks for fixing all these, Randy!
Reviewed-by: Andy Shevchenko <andriy.shevchenko@...el.com>

-- 
With Best Regards,
Andy Shevchenko