linux-kernel - Re: [PATCH] irqdomain: Fix the kernel-doc and plug it into Documentation

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <4fea1a35-1079-43c6-8719-d56e3e7f1a0c@infradead.org>
Date: Fri, 12 Jul 2024 21:06:55 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: "Jiri Slaby (SUSE)" <jirislaby@...nel.org>, tglx@...utronix.de
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] irqdomain: Fix the kernel-doc and plug it into
 Documentation



On 7/11/24 11:41 PM, Jiri Slaby (SUSE) wrote:
> There were several undocumented fields in structs irq_domain_ops and
> irq_domain_info. Document them.
> 
> irq_domain_ops::revmap_size contained "[]" in the description, which is
> not allowed in sphinx. Remove that.
> 
> Finally, plug the whole header (irqdomain.h) into genericirq.rst, so
> that the docs is autogenerated and hyperlinks to these structure
> created.
> 
> Signed-off-by: Jiri Slaby (SUSE) <jirislaby@...nel.org>
> Cc: Thomas Gleixner <tglx@...utronix.de>
> Cc: Jonathan Corbet <corbet@....net>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.


> ---
>  Documentation/core-api/genericirq.rst |  2 ++
>  include/linux/irqdomain.h             | 20 +++++++++++++++++++-
>  2 files changed, 21 insertions(+), 1 deletion(-)


-- 
~Randy