linux-kernel - Re: [PATCH 3/8] regulator: core: 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] [day] [month] [year] [list]

Message-ID: <5696fe5b-2453-4aee-b928-43aa038211b0@sirena.org.uk>
Date: Wed, 28 Aug 2024 21:29:39 +0100
From: Mark Brown <broonie@...nel.org>
To: Chen-Yu Tsai <wenst@...omium.org>
Cc: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
	Liam Girdwood <lgirdwood@...il.com>, linux-kernel@...r.kernel.org,
	linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH 3/8] regulator: core: Fix incorrectly formatted kerneldoc
 "Return" sections

On Wed, Aug 28, 2024 at 04:01:52PM +0800, Chen-Yu Tsai wrote:
> On Tue, Aug 27, 2024 at 10:42 PM Andy Shevchenko
> > On Tue, Aug 27, 2024 at 05:55:43PM +0800, Chen-Yu Tsai wrote:

> > > + * Return: pointer to a &struct regulator corresponding to the regulator
> > > + *      producer, or ERR_PTR() encoded negative error number.

> > (I'm not sure of definite vs. indefinite article, though. Perhaps you need to
> > consult with native speaker.)

> I think "a" makes more sense, because in the case of _regulator_get(),
> the |struct regulator| consumer instances are allocated separately on
> the fly for each call.

Your text is perfectly fine and completely intelligible.

Download attachment "signature.asc" of type "application/pgp-signature" (489 bytes)