linux-kernel - Re: [PATCH] iio: buffer: buffer_impl.h: fix kernel-doc warnings

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: <0598bfa4-fb8c-495e-875c-4ad7a724cd83@infradead.org>
Date: Wed, 28 Jan 2026 10:27:26 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Andy Shevchenko <andriy.shevchenko@...el.com>
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: buffer: buffer_impl.h: fix kernel-doc warnings

Hi,

On 1/28/26 1:44 AM, Andy Shevchenko wrote:
> On Tue, Jan 27, 2026 at 10:25:49PM -0800, Randy Dunlap wrote:
>> Resolve all kernel-doc warnings in buffer_impl.h:
>>
>> Warning: include/linux/iio/buffer_impl.h:172 struct member 'direction' not described in 'iio_buffer'
>> Warning: include/linux/iio/buffer_impl.h:184 No description found for return value of 'iio_update_buffers'
>>
>> Also correct one typo (word order switch).
> 
> ...
> 
>>  	/**  @bytes_per_datum: Size of individual datum including timestamp. */
> 
> Shouldn't we also delete here...

Yes, that's the oddball in this file.
I could adjust that...

> 
>> -	/* @direction: Direction of the data stream (in/out). */
>> +	/** @direction: Direction of the data stream (in/out). */
> 
> ...or add here an extra space after asterisk?

Negative.

-- 
~Randy