| a10024e6 | 19-Mar-2025 |
Jiri Slaby (SUSE) <jirislaby@kernel.org> |
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
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 b7b377332b96 ("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
show more ...
|
| a4efe303 | 19-Mar-2025 |
Jiri Slaby (SUSE) <jirislaby@kernel.org> |
Documentation: irqdomain: Update it
The irqdomain documentaion became obsolete over time. Update and extend it a bit with respect to the current code and HW.
Most notably the doubled documentation
Documentation: irqdomain: Update it
The irqdomain documentaion became obsolete over time. Update and extend it a bit with respect to the current code and HW.
Most notably the doubled documentation of irq_domain (from .rst and .h) was unified and let only in .rst. A reference link was added to .h.
Furthermore: * Add some 'struct' keywords, so that the respective structs are hyperlinked * :c:member: use where appropriate to mark a member of a struct * Rephrase some wording to improve readability/understanding
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-57-jirislaby@kernel.org
show more ...
|
| 95cfac1b | 19-Mar-2025 |
Jiri Slaby (SUSE) <jirislaby@kernel.org> |
Documentation: irq-domain.rst: Simple improvements
The improvements include:
* Capitals in headlines. * Add commas: for easier reading, it is always desired to add commas at some places in
Documentation: irq-domain.rst: Simple improvements
The improvements include:
* Capitals in headlines. * Add commas: for easier reading, it is always desired to add commas at some places in text. Like before adverbs or after fronted sentences. * 3rd person -> add 's' to verbs. * End some sentences with period and start a new one. Avoid thus heavy sentences.
[ tglx: Fix up subject prefix ]
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-56-jirislaby@kernel.org
show more ...
|
| 225942f0 | 19-Mar-2025 |
Jiri Slaby (SUSE) <jirislaby@kernel.org> |
Documentation: irq/concepts: Minor improvements
Just note in the docs:
1) A PCI device as an example for shared interrupts 2) A sparse tree can be used for interrupts too 3) i8259s which have 8
Documentation: irq/concepts: Minor improvements
Just note in the docs:
1) A PCI device as an example for shared interrupts 2) A sparse tree can be used for interrupts too 3) i8259s which have 8 pins
[ tglx: Fix up subject prefix ]
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-55-jirislaby@kernel.org
show more ...
|
| 2f7bd329 | 19-Mar-2025 |
Jiri Slaby (SUSE) <jirislaby@kernel.org> |
Documentation: irq/concepts: Add commas and reflow
For easier reading, it is always desired to add commas at some places in text. Like before adverbs or after fronted sentences.
[ tglx: Fix up subj
Documentation: irq/concepts: Add commas and reflow
For easier reading, it is always desired to add commas at some places in text. Like before adverbs or after fronted sentences.
[ tglx: Fix up subject prefix ]
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-54-jirislaby@kernel.org
show more ...
|
| 42b8b16f | 19-Mar-2025 |
Jiri Slaby (SUSE) <jirislaby@kernel.org> |
irqdomain: Drop irq_domain_add_*() functions
Most irq_domain_add_*() functions are unused now, so drop them. The remaining ones are moved to the deprecated section and will be removed during the mer
irqdomain: Drop irq_domain_add_*() functions
Most irq_domain_add_*() functions are unused now, so drop them. The remaining ones are moved to the deprecated section and will be removed during the merge window after the patches in various trees have been merged.
Note: The Chinese docs are touched but unfinished. I cannot parse those.
[ tglx: Remove the leftover in irq-domain.rst and handle merge logistics ]
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-41-jirislaby@kernel.org
show more ...
|