Skip to content

Commit a10024e

Browse files
Jiri Slaby (SUSE)KAGA-KOKO
authored andcommitted
irqdomain: Fix kernel-doc and add it to Documentation
irqdomain.c's kernel-doc exists, but is not plugged into Documentation/ yet. Before plugging it in, fix it first: irq_domain_get_irq_data() and irq_domain_set_info() were documented twice. Identically, by both definitions for CONFIG_IRQ_DOMAIN_HIERARCHY and !CONFIG_IRQ_DOMAIN_HIERARCHY. Therefore, switch the second kernel-doc into an ordinary comment -- change "/**" to simple "/*". This avoids sphinx's: WARNING: Duplicate C declaration Next, in commit b7b3773 ("irqdomain: Fix the kernel-doc and plug it into Documentation"), irqdomain.h's (header) kernel-doc was added into core-api/genericirq.rst. But given the amount of irqdomain functions and structures, move all these to core-api/irq/irq-domain.rst now. Finally, add these newly fixed irqdomain.c's (source) docs there as well. Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Link: https://lore.kernel.org/all/20250319092951.37667-58-jirislaby@kernel.org
1 parent a4efe30 commit a10024e

File tree

3 files changed

+22
-4
lines changed

3 files changed

+22
-4
lines changed

Documentation/core-api/genericirq.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,8 +410,6 @@ which are used in the generic IRQ layer.
410410
.. kernel-doc:: include/linux/interrupt.h
411411
:internal:
412412

413-
.. kernel-doc:: include/linux/irqdomain.h
414-
415413
Public Functions Provided
416414
=========================
417415

Documentation/core-api/irq/irq-domain.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,3 +298,23 @@ Debugging
298298

299299
Most of the internals of the IRQ subsystem are exposed in debugfs by
300300
turning CONFIG_GENERIC_IRQ_DEBUGFS on.
301+
302+
Structures and Public Functions Provided
303+
========================================
304+
305+
This chapter contains the autogenerated documentation of the structures
306+
and exported kernel API functions which are used for IRQ domains.
307+
308+
.. kernel-doc:: include/linux/irqdomain.h
309+
310+
.. kernel-doc:: kernel/irq/irqdomain.c
311+
:export:
312+
313+
Internal Functions Provided
314+
===========================
315+
316+
This chapter contains the autogenerated documentation of the internal
317+
functions.
318+
319+
.. kernel-doc:: kernel/irq/irqdomain.c
320+
:internal:

kernel/irq/irqdomain.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1996,7 +1996,7 @@ static void irq_domain_check_hierarchy(struct irq_domain *domain)
19961996
domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
19971997
}
19981998
#else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1999-
/**
1999+
/*
20002000
* irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
20012001
* @domain: domain to match
20022002
* @virq: IRQ number to get irq_data
@@ -2010,7 +2010,7 @@ struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
20102010
}
20112011
EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
20122012

2013-
/**
2013+
/*
20142014
* irq_domain_set_info - Set the complete data for a @virq in @domain
20152015
* @domain: Interrupt domain to match
20162016
* @virq: IRQ number

0 commit comments

Comments
 (0)