linux-kernel - Re: [PATCH] doc-guide: kernel-doc: document Returns: spelling

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: <87ed9jcctt.fsf@meer.lwn.net>
Date: Thu, 30 May 2024 13:35:42 -0600
From: Jonathan Corbet <corbet@....net>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>, Dmitry Baryshkov
 <dmitry.baryshkov@...aro.org>, linux-doc@...r.kernel.org
Subject: Re: [PATCH] doc-guide: kernel-doc: document Returns: spelling

Randy Dunlap <rdunlap@...radead.org> writes:

> scripts/kernel-doc accepts "Return:" or "Returns:" for describing the
> return value of a function or function-like macro, so document this
> alternative spelling and use it in an example.
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Suggested-by: Dmitry Baryshkov <dmitry.baryshkov@...aro.org>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> ---
>  Documentation/doc-guide/kernel-doc.rst |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Applied, thanks.

jon