Skip to contentSkip to conversation

genirq: Fix warning while make xmldocs caused by chip.c

PATCH New Masanari Iida 2 participants 2 messages Jul 29, 2015 IRQ

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 genirq: Fix warning while make xmldocs caused by chip.c

This patch fix following warning while make xmldocs.

Warning(.//kernel/irq/chip.c:1009): No description found for parameter 'vcpu_info' Warning(.//kernel/irq/chip.c:1009): Excess function parameter 'dest' description in 'irq_chip_set_vcpu_affinity_parent'

---
 kernel/irq/chip.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/irq/chip.c +1 -1
index 76f199d..09304a6 100644
@@ -1003,7 +1003,7 @@ int irq_chip_retrigger_hierarchy(struct irq_data *data)
 /**
  * irq_chip_set_vcpu_affinity_parent - Set vcpu affinity on the parent interrupt
  * @data:	Pointer to interrupt specific data
- * @dest:	The vcpu affinity information
+ * @vcpu_info:	The vcpu affinity information
  */
 int irq_chip_set_vcpu_affinity_parent(struct irq_data *data, void *vcpu_info)
 {
Signature · 1 line
2.5.0
#1 lore raw

[tip:irq/core] genirq: Use the proper parameter name in kernel doc

genirq: Use the proper parameter name in kernel doc
Commit-ID:  8505a81bb036253213b109baf4178ea6861e2888
Gitweb:     http://git.kernel.org/tip/8505a81bb036253213b109baf4178ea6861e2888
Author:     Masanari Iida <[email protected]>
AuthorDate: Wed, 29 Jul 2015 19:09:36 +0900
Committer:  Thomas Gleixner <[email protected]>
CommitDate: Thu, 30 Jul 2015 00:14:36 +0200

genirq: Use the proper parameter name in kernel doc

The following warning is emitted for make xmldocs:

Warning(.//kernel/irq/chip.c:1009): No description found for parameter 'vcpu_info' Warning(.//kernel/irq/chip.c:1009): Excess function parameter 'dest' description in 'irq_chip_set_vcpu_affinity_parent'

---
 kernel/irq/chip.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/irq/chip.c +1 -1
index 76f199d..09304a6 100644
@@ -1003,7 +1003,7 @@ int irq_chip_retrigger_hierarchy(struct irq_data *data)
 /**
  * irq_chip_set_vcpu_affinity_parent - Set vcpu affinity on the parent interrupt
  * @data:	Pointer to interrupt specific data
- * @dest:	The vcpu affinity information
+ * @vcpu_info:	The vcpu affinity information
  */
 int irq_chip_set_vcpu_affinity_parent(struct irq_data *data, void *vcpu_info)
 {