Skip to contentSkip to conversation

genirq: fix the kerneldoc comment for struct irq_affinity_desc

PATCH New Jonathan Corbet 2 participants 3 messages Jan 9, 2019 – Jan 17, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 genirq: fix the kerneldoc comment for struct irq_affinity_desc

Commit c410abbbacb9 ("genirq/affinity: Add is_managed to struct irq_affinity_desc") added a new field but did not update the kerneldoc comment, leading to this build warning:

./include/linux/interrupt.h:268: warning: Function parameter or member 'is_managed' not described in 'irq_affinity_desc'

Add the missing information, making the docs build 0.001% quieter.

---
 include/linux/interrupt.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/interrupt.h +1 -0
index c672f34235e7..4a728dba02e2 100644
@@ -260,6 +260,7 @@ struct irq_affinity {
 /**
  * struct irq_affinity_desc - Interrupt affinity descriptor
  * @mask:	cpumask to hold the affinity assignment
+ * @is_managed: 1 if the interrupt is managed internally
  */
 struct irq_affinity_desc {
 	struct cpumask	mask;
Signature · 1 line
2.20.1
#1 lore raw

[tip:irq/urgent] genirq: Fix the kerneldoc comment for struct irq_affinity_desc

genirq: Fix the kerneldoc comment for struct irq_affinity_desc
Commit-ID:  f0ca26ca4f36dc781cc50c15ca63a5cf02d720dc
Gitweb:     https://git.kernel.org/tip/f0ca26ca4f36dc781cc50c15ca63a5cf02d720dc
Author:     Jonathan Corbet <[email protected]>
AuthorDate: Tue, 8 Jan 2019 17:04:32 -0700
Committer:  Thomas Gleixner <[email protected]>
CommitDate: Tue, 15 Jan 2019 17:09:33 +0100

genirq: Fix the kerneldoc comment for struct irq_affinity_desc

A recent commit added a new field but did not update the kerneldoc comment, leading to this build warning:

./include/linux/interrupt.h:268: warning: Function parameter or member 'is_managed' not described in 'irq_affinity_desc'

Add the missing information, making the docs build 0.001% quieter.

Fixes Commit c410abbbacb9 ("genirq/affinity: Add is_managed to struct irq_affinity_desc")
Cc Dou Liyang <[email protected]>
---
 include/linux/interrupt.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/interrupt.h +1 -0
index c672f34235e7..4a728dba02e2 100644
@@ -260,6 +260,7 @@ struct irq_affinity {
 /**
  * struct irq_affinity_desc - Interrupt affinity descriptor
  * @mask:	cpumask to hold the affinity assignment
+ * @is_managed: 1 if the interrupt is managed internally
  */
 struct irq_affinity_desc {
 	struct cpumask	mask;
#2 lore raw

[tip:irq/urgent] genirq: Fix the kerneldoc comment for struct irq_affinity_desc

In reply to Jonathan Corbet
genirq: Fix the kerneldoc comment for struct irq_affinity_desc
Commit-ID:  70921ae25f944423f0abf096f73455c586da0652
Gitweb:     https://git.kernel.org/tip/70921ae25f944423f0abf096f73455c586da0652
Author:     Jonathan Corbet <[email protected]>
AuthorDate: Tue, 8 Jan 2019 17:04:32 -0700
Committer:  Thomas Gleixner <[email protected]>
CommitDate: Fri, 18 Jan 2019 00:18:45 +0100

genirq: Fix the kerneldoc comment for struct irq_affinity_desc

A recent commit added a new field but did not update the kerneldoc comment, leading to this build warning:

./include/linux/interrupt.h:268: warning: Function parameter or member 'is_managed' not described in 'irq_affinity_desc'

Add the missing information, making the docs build 0.001% quieter.

Fixes c410abbbacb9 ("genirq/affinity: Add is_managed to struct irq_affinity_desc")
Cc Dou Liyang <[email protected]>
---
 include/linux/interrupt.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/interrupt.h +1 -0
index c672f34235e7..4a728dba02e2 100644
@@ -260,6 +260,7 @@ struct irq_affinity {
 /**
  * struct irq_affinity_desc - Interrupt affinity descriptor
  * @mask:	cpumask to hold the affinity assignment
+ * @is_managed: 1 if the interrupt is managed internally
  */
 struct irq_affinity_desc {
 	struct cpumask	mask;