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

From: Randy Dunlap
Date: Sat Jul 13 2024 - 00:07:10 EST




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@xxxxxxxxxx>
> Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.


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


--
~Randy