lkml.org 
[lkml]   [2017]   [Feb]   [10]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH] genirq: fix comment to __handle_domain_irq
    On Tue, 10 Jan 2017, Vladimir Murzin wrote:
    > NULL domain is valid parameter and handled as default irq domain by
    > irq_find_mapping(). Instead of using NULL domain, dedicated "lookup"
    > parameter should be used to indicate whether conversion of HW
    > interrupt to the logical one is needed or not.
    >
    > Cc: Thomas Gleixner <tglx@linutronix.de>
    > Cc: Marc Zyngier <marc.zyngier@arm.com>
    > Signed-off-by: Vladimir Murzin <vladimir.murzin@arm.com>
    > ---
    > include/linux/irqdesc.h | 2 +-
    > 1 file changed, 1 insertion(+), 1 deletion(-)
    >
    > diff --git a/include/linux/irqdesc.h b/include/linux/irqdesc.h
    > index c9be579..8f5f7d9 100644
    > --- a/include/linux/irqdesc.h
    > +++ b/include/linux/irqdesc.h
    > @@ -156,7 +156,7 @@ static inline void generic_handle_irq_desc(struct irq_desc *desc)
    > /*
    > * Convert a HW interrupt number to a logical one using a IRQ domain,
    > * and handle the result interrupt number. Return -EINVAL if
    > - * conversion failed. Providing a NULL domain indicates that the
    > + * conversion failed. Providing lookup set to false indicates that the
    > * conversion has already been done.
    > */

    We should just remove that comment completely as we have a proper and
    correct kernel doc annotation for that function where its
    implemented. Having two places to document stuff is just wrong.

    Thanks,

    tglx

    \
     
     \ /
      Last update: 2017-02-10 13:06    [W:4.542 / U:0.008 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site