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] [day] [month] [year] [list]

Message-ID: <20251027143710.35ca032f@jic23-huawei>
Date: Mon, 27 Oct 2025 14:37:10 +0000
From: Jonathan Cameron <jic23@...nel.org>
To: Nuno Sá <noname.nuno@...il.com>
Cc: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.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 Mon, 27 Oct 2025 13:03:54 +0000
Nuno Sá <noname.nuno@...il.com> wrote:

> On Sat, 2025-10-25 at 19:47 -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'
> > 
> > Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> > ---  
> 
> Thanks!
> 
> Reviewed-by: Nuno Sá <nuno.sa@...log.com>

Applied.  Thanks.

Jonathan