All of lore.kernel.org
 help / color / mirror / Atom feed
From: Marc Zyngier <maz@kernel.org>
To: Krzysztof Kozlowski <krzk@kernel.org>
Cc: Nishanth Menon <nm@ti.com>, Jason Cooper <jason@lakedaemon.net>,
	linux-kernel@vger.kernel.org, Tero Kristo <t-kristo@ti.com>,
	Santosh Shilimkar <ssantosh@kernel.org>,
	Thomas Gleixner <tglx@linutronix.de>,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 2/2] irqchip/ti-sci-inta: Fix kerneldoc
Date: Sun, 13 Sep 2020 16:34:05 +0100	[thread overview]
Message-ID: <87mu1tr8r6.wl-maz@kernel.org> (raw)
In-Reply-To: <20200902174615.24695-2-krzk@kernel.org>

On Wed, 02 Sep 2020 18:46:15 +0100,
Krzysztof Kozlowski <krzk@kernel.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@kernel.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.

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

WARNING: multiple messages have this Message-ID (diff)
From: Marc Zyngier <maz@kernel.org>
To: Krzysztof Kozlowski <krzk@kernel.org>
Cc: Nishanth Menon <nm@ti.com>, Tero Kristo <t-kristo@ti.com>,
	Santosh Shilimkar <ssantosh@kernel.org>,
	Thomas Gleixner <tglx@linutronix.de>,
	Jason Cooper <jason@lakedaemon.net>,
	linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 2/2] irqchip/ti-sci-inta: Fix kerneldoc
Date: Sun, 13 Sep 2020 16:34:05 +0100	[thread overview]
Message-ID: <87mu1tr8r6.wl-maz@kernel.org> (raw)
In-Reply-To: <20200902174615.24695-2-krzk@kernel.org>

On Wed, 02 Sep 2020 18:46:15 +0100,
Krzysztof Kozlowski <krzk@kernel.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@kernel.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.

  reply	other threads:[~2020-09-13 15:35 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-02 17:46 [PATCH 1/2] irqchip/ti-sci: Simplify with dev_err_probe() Krzysztof Kozlowski
2020-09-02 17:46 ` Krzysztof Kozlowski
2020-09-02 17:46 ` [PATCH 2/2] irqchip/ti-sci-inta: Fix kerneldoc Krzysztof Kozlowski
2020-09-02 17:46   ` Krzysztof Kozlowski
2020-09-13 15:34   ` Marc Zyngier [this message]
2020-09-13 15:34     ` Marc Zyngier
2020-09-13 17:05 ` [PATCH 1/2] irqchip/ti-sci: Simplify with dev_err_probe() Marc Zyngier
2020-09-13 17:05   ` Marc Zyngier
2020-09-13 17:05   ` Marc Zyngier
2020-10-11 17:57 ` [tip: irq/core] " tip-bot2 for Krzysztof Kozlowski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87mu1tr8r6.wl-maz@kernel.org \
    --to=maz@kernel.org \
    --cc=jason@lakedaemon.net \
    --cc=krzk@kernel.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nm@ti.com \
    --cc=ssantosh@kernel.org \
    --cc=t-kristo@ti.com \
    --cc=tglx@linutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.