linux-kernel - Re: [PATCH 2/2] irqchip/ti-sci-inta: Fix kerneldoc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87mu1tr8r6.wl-maz@kernel.org>
Date:   Sun, 13 Sep 2020 16:34:05 +0100
From:   Marc Zyngier <maz@...nel.org>
To:     Krzysztof Kozlowski <krzk@...nel.org>
Cc:     Nishanth Menon <nm@...com>, Tero Kristo <t-kristo@...com>,
        Santosh Shilimkar <ssantosh@...nel.org>,
        Thomas Gleixner <tglx@...utronix.de>,
        Jason Cooper <jason@...edaemon.net>,
        linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 2/2] irqchip/ti-sci-inta: Fix kerneldoc

On Wed, 02 Sep 2020 18:46:15 +0100,
Krzysztof Kozlowski <krzk@...nel.org> wrote:
> 
> Fix kerneldoc W=1 warnings:
> 
>   drivers/irqchip/irq-ti-sci-inta.c:144: warning: Function parameter or member 'vint_id' not described in 'ti_sci_inta_xlate_irq'
>   drivers/irqchip/irq-ti-sci-inta.c:144: warning: Excess function parameter 'irq' description in 'ti_sci_inta_xlate_irq'
> 
> Signed-off-by: Krzysztof Kozlowski <krzk@...nel.org>
> ---
>  drivers/irqchip/irq-ti-sci-inta.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/irqchip/irq-ti-sci-inta.c b/drivers/irqchip/irq-ti-sci-inta.c
> index bc863ef7998d..84929f3e2003 100644
> --- a/drivers/irqchip/irq-ti-sci-inta.c
> +++ b/drivers/irqchip/irq-ti-sci-inta.c
> @@ -134,7 +134,7 @@ static void ti_sci_inta_irq_handler(struct irq_desc *desc)
>  /**
>   * ti_sci_inta_xlate_irq() - Translate hwirq to parent's hwirq.
>   * @inta:	IRQ domain corresponding to Interrupt Aggregator
> - * @irq:	Hardware irq corresponding to the above irq domain
> + * @vint_id:	TISCI vint ID

I'm not sure that replacing a flaky variable name with something that
is essentially unintelligible is a huge improvement.

	M.

-- 
Without deviation from the norm, progress is not possible.