Re: linux-next: Tree for December 18 (irq.h documentation)

Yinghai Lu
2008-12-19T00:34:32Z

Randy Dunlap wrote:
> Hi YH,
>
> Whenever you update a struct in a header file that uses kernel-doc,
> like struct irq_desc in include/linux/irq.h, please also update the
> corresponding kernel-doc notation for the new struct members, so
> that kernel-doc warnings are not caused:
>
> from linux-next-20081218:
>
> Warning(linux-next-20081218//include/linux/irq.h:192): No description found for parameter 'timer_rand_state'
> Warning(linux-next-20081218//include/linux/irq.h:192): No description found for parameter 'kstat_irqs'
> Warning(linux-next-20081218//include/linux/irq.h:192): No description found for parameter 'irq_2_iommu'
>
>
please check

[PATCH] sparseirq: add kernel-doc notation for new member in irq_desc

Signed-off-by: Yinghai Lu <yinghai@kernel.org>

diff --git a/include/linux/irq.h b/include/linux/irq.h
index 1beb63a..4675682 100644
--- a/include/linux/irq.h
+++ b/include/linux/irq.h
@@ -135,6 +135,9 @@ struct irq_2_iommu;
/**
* struct irq_desc - interrupt descriptor
* @irq: interrupt number for this descriptor
+ * @timer_rand_state pointer to timer rand state struct
+ * @kstat_irqs irq stats per cpu
+ * @irq_2_iommu iommu with this irq
* @handle_irq: highlevel irq-events handler [if NULL, __do_IRQ()]
* @chip: low level interrupt hardware access
* @msi_desc: MSI descriptor