linux-kernel - Re: [PATCH] kernel-doc: allow object-like macros in ReST output

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: <87frou3fs0.fsf@trenco.lwn.net>
Date: Thu, 17 Oct 2024 09:33:51 -0600
From: Jonathan Corbet <corbet@....net>
To: Randy Dunlap <rdunlap@...radead.org>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>, Horia Geanta
 <horia.geanta@...escale.com>, Vlastimil Babka <vbabka@...e.cz>
Subject: Re: [PATCH] kernel-doc: allow object-like macros in ReST output

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

> output_function_rst() does not handle object-like macros. It presents
> a trailing "()" while output_function_man() handles these macros
> correctly.
>
> Update output_function_rst() to handle object-like macros.
> Don't show the "Parameters" heading if there are no parameters.
>
> For output_function_man(), don't show the "ARGUMENTS" heading if there
> are no parameters.
>
> I have tested this quite a bit with my ad hoc test files for both ReST
> and man format outputs. The generated output looks good.
>
> Fixes: cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros")
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Horia Geanta <horia.geanta@...escale.com>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: Vlastimil Babka <vbabka@...e.cz>
> ---
> Cc: linux-doc@...r.kernel.org
>
> @Jon, feel free to update the attribution for your patch or I can do it
> and send a v2 if you like.
>
>  scripts/kernel-doc |   43 ++++++++++++++++++++++++++++++-------------
>  1 file changed, 30 insertions(+), 13 deletions(-)

Applied - thanks for doing this.

jon