Skip to contentSkip to conversation

genirq/matrix: fix doc warnings in matrix.c

PATCH Applied Baokun Li 2 participants 3 messages Jun 5, 2021 – Aug 10, 2021 IRQ

lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 genirq/matrix: fix doc warnings in matrix.c

Fixes the following W=1 kernel build warning(s):

kernel/irq/matrix.c:287: warning: Function parameter or
member 'msk' not described in 'irq_matrix_alloc_managed'
kernel/irq/matrix.c:287: warning: Function parameter or
member 'mapped_cpu' not described in 'irq_matrix_alloc_managed'
kernel/irq/matrix.c:287: warning: Excess function
parameter 'cpu' description in 'irq_matrix_alloc_managed'

---
 kernel/irq/matrix.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
kernel/irq/matrix.c +2 -1
index 578596e41cb6..bbfb26489aa1 100644
@@ -280,7 +280,8 @@ void irq_matrix_remove_managed(struct irq_matrix *m, const struct cpumask *msk)
 /**
  * irq_matrix_alloc_managed - Allocate a managed interrupt in a CPU map
  * @m:		Matrix pointer
- * @cpu:	On which CPU the interrupt should be allocated
+ * @msk:	Which CPUs to search in
+ * @mapped_cpu:	Pointer to store the CPU for which the irq was allocated
  */
 int irq_matrix_alloc_managed(struct irq_matrix *m, const struct cpumask *msk,
 			     unsigned int *mapped_cpu)
Signature · 1 line
2.31.1
merge bot Applied
#1 lore raw

[tip: irq/core] genirq/matrix: Fix kernel doc warnings for irq_matrix_alloc_managed()

The following commit has been merged into the irq/core branch of tip:

The following commit has been merged into the irq/core branch of tip:

Commit-ID:     1d07a835819e2d3c85af8f093a02c2e6bca422d6
Gitweb:        https://git.kernel.org/tip/1d07a835819e2d3c85af8f093a02c2e6bca422d6
Author:        Baokun Li <[email protected]>
AuthorDate:    Sat, 05 Jun 2021 14:34:13 +08:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Tue, 10 Aug 2021 16:46:26 +02:00

genirq/matrix: Fix kernel doc warnings for irq_matrix_alloc_managed()

Describe the arguments correctly.

Fixes the following W=1 kernel build warning(s):

kernel/irq/matrix.c:287: warning: Function parameter or
member 'msk' not described in 'irq_matrix_alloc_managed'
kernel/irq/matrix.c:287: warning: Function parameter or
member 'mapped_cpu' not described in 'irq_matrix_alloc_managed'
kernel/irq/matrix.c:287: warning: Excess function
parameter 'cpu' description in 'irq_matrix_alloc_managed'

---
 kernel/irq/matrix.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
kernel/irq/matrix.c +2 -1
index 578596e..bbfb264 100644
@@ -280,7 +280,8 @@ void irq_matrix_remove_managed(struct irq_matrix *m, const struct cpumask *msk)
 /**
  * irq_matrix_alloc_managed - Allocate a managed interrupt in a CPU map
  * @m:		Matrix pointer
- * @cpu:	On which CPU the interrupt should be allocated
+ * @msk:	Which CPUs to search in
+ * @mapped_cpu:	Pointer to store the CPU for which the irq was allocated
  */
 int irq_matrix_alloc_managed(struct irq_matrix *m, const struct cpumask *msk,
 			     unsigned int *mapped_cpu)
merge bot Applied
#2 lore raw

[tip: irq/core] genirq/matrix: Fix kernel doc warnings for irq_matrix_alloc_managed()

In reply to Baokun Li
The following commit has been merged into the irq/core branch of tip:

The following commit has been merged into the irq/core branch of tip:

Commit-ID:     92848731c45f4f9c3d9818e6b4ba1b2884002324
Gitweb:        https://git.kernel.org/tip/92848731c45f4f9c3d9818e6b4ba1b2884002324
Author:        Baokun Li <[email protected]>
AuthorDate:    Sat, 05 Jun 2021 14:34:13 +08:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Tue, 10 Aug 2021 22:50:07 +02:00

genirq/matrix: Fix kernel doc warnings for irq_matrix_alloc_managed()

Describe the arguments correctly.

Fixes the following W=1 kernel build warning(s):

kernel/irq/matrix.c:287: warning: Function parameter or
member 'msk' not described in 'irq_matrix_alloc_managed'
kernel/irq/matrix.c:287: warning: Function parameter or
member 'mapped_cpu' not described in 'irq_matrix_alloc_managed'
kernel/irq/matrix.c:287: warning: Excess function
parameter 'cpu' description in 'irq_matrix_alloc_managed'

---
 kernel/irq/matrix.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
kernel/irq/matrix.c +2 -1
index 578596e..bbfb264 100644
@@ -280,7 +280,8 @@ void irq_matrix_remove_managed(struct irq_matrix *m, const struct cpumask *msk)
 /**
  * irq_matrix_alloc_managed - Allocate a managed interrupt in a CPU map
  * @m:		Matrix pointer
- * @cpu:	On which CPU the interrupt should be allocated
+ * @msk:	Which CPUs to search in
+ * @mapped_cpu:	Pointer to store the CPU for which the irq was allocated
  */
 int irq_matrix_alloc_managed(struct irq_matrix *m, const struct cpumask *msk,
 			     unsigned int *mapped_cpu)