]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
irqdomain: Fix the kernel-doc and plug it into Documentation
authorJiri Slaby (SUSE) <jirislaby@kernel.org>
Fri, 12 Jul 2024 06:41:48 +0000 (08:41 +0200)
committerThomas Gleixner <tglx@linutronix.de>
Mon, 15 Jul 2024 13:13:56 +0000 (15:13 +0200)
commitb7b377332b96a38bc98928d7ec2674c77a95fcb3
tree97f306c176a050f97d6ce1fecb047dc0da6f0492
parentc37927a203fa283950f6045602b9f71328ad786c
irqdomain: Fix the kernel-doc and plug it into Documentation

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 are created.

Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20240712064148.157040-1-jirislaby@kernel.org
Documentation/core-api/genericirq.rst
include/linux/irqdomain.h