linux-kernel - Re: [PATCH v2 05/10] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections

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: <ZtBuJbQozUnp6z_0@smile.fi.intel.com>
Date: Thu, 29 Aug 2024 15:48:37 +0300
From: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To: Chen-Yu Tsai <wenst@...omium.org>
Cc: Mark Brown <broonie@...nel.org>, Liam Girdwood <lgirdwood@...il.com>,
	linux-kernel@...r.kernel.org, linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH v2 05/10] regulator: of: Fix incorrectly formatted
 kerneldoc "Return" sections

On Thu, Aug 29, 2024 at 04:51:25PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for many documented
> functions in the regulator OF-specific code. These all have descriptions
> about the return values, just not in the format kernel-doc wants.
> 
> Convert these to use the proper "Return:" section header. The existing
> descriptions have been reworded and moved around to fit the grammar and
> formatting.

...

> - * Returns true if all conditions are met.
> + * Return: True if all conditions are met; false otherwise.

You used %NULL elsewhere, so this also can use references to the boolean
constants.

 * Return: %true if all conditions are met; %false otherwise.

-- 
With Best Regards,
Andy Shevchenko