Skip to contentSkip to conversation

linux/interrupt.h: fix struct irqaction comment order inconsistency

PATCH In review ChengChaoChun 2 participants 2 messages Jul 8, 2024 – Jul 26, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 linux/interrupt.h: fix struct irqaction comment order inconsistency

Rearrange struct irqaction comment to match member order in the code.

---
 include/linux/interrupt.h | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)
include/linux/interrupt.h +13 -13
index 5c9bdd3ffccc..b405e181829b 100644
@@ -104,19 +104,19 @@ typedef irqreturn_t (*irq_handler_t)(int, void *);
 
 /**
  * struct irqaction - per interrupt action descriptor
- * @handler:	interrupt handler function
- * @name:	name of the device
- * @dev_id:	cookie to identify the device
- * @percpu_dev_id:	cookie to identify the device
- * @next:	pointer to the next irqaction for shared interrupts
- * @irq:	interrupt number
- * @flags:	flags (see IRQF_* above)
- * @thread_fn:	interrupt handler function for threaded interrupts
- * @thread:	thread pointer for threaded interrupts
- * @secondary:	pointer to secondary irqaction (force threading)
- * @thread_flags:	flags related to @thread
- * @thread_mask:	bitmask for keeping track of @thread activity
- * @dir:	pointer to the proc/irq/NN/name entry
+ * @handler:    interrupt handler function
+ * @dev_id:     cookie to identify the device
+ * @percpu_dev_id:      cookie to identify the device
+ * @next:       pointer to the next irqaction for shared interrupts
+ * @thread_fn:  interrupt handler function for threaded interrupts
+ * @thread:     thread pointer for threaded interrupts
+ * @secondary:  pointer to secondary irqaction (force threading)
+ * @irq:        interrupt number
+ * @flags:      flags (see IRQF_* above)
+ * @thread_flags:       flags related to @thread
+ * @thread_mask:        bitmask for keeping track of @thread activity
+ * @name:       name of the device
+ * @dir:        pointer to the proc/irq/NN/name entry
  */
 struct irqaction {
 	irq_handler_t		handler;
Signature · 1 line
2.34.1
#1 lore raw
Quoted 8 lines · ChengChaoChun

/**
* struct irqaction - per interrupt action descriptor
- * @handler: interrupt handler function
- * @name: name of the device
- * @dev_id: cookie to identify the device
- * @percpu_dev_id: cookie to identify the device
- * @next: pointer to the next irqaction for shared interrupts
- * @irq: interrupt number

Quoted 8 lines

- * @flags: flags (see IRQF_* above)
- * @thread_fn: interrupt handler function for threaded interrupts
- * @thread: thread pointer for threaded interrupts
- * @secondary: pointer to secondary irqaction (force threading)
- * @thread_flags: flags related to @thread
- * @thread_mask: bitmask for keeping track of @thread activity
- * @dir: pointer to the proc/irq/NN/name entry
+ * @handler: interrupt handler function

This changes tabs to spaces ....

Quoted 10 lines

+ * @dev_id: cookie to identify the device
+ * @percpu_dev_id: cookie to identify the device

+ * @next:       pointer to the next irqaction for shared interrupts
+ * @thread_fn:  interrupt handler function for threaded interrupts
+ * @thread:     thread pointer for threaded interrupts
+ * @secondary:  pointer to secondary irqaction (force threading)
+ * @irq:        interrupt number
+ * @flags:      flags (see IRQF_* above)

+ * @thread_flags: flags related to @thread
+ * @thread_mask: bitmask for keeping track of @thread activity

And while at it, please align all members in a tabular fashion.

Thanks,

tglx