linux-kernel - Re: [PATCH v3 14/14] irqchip: Fix kernel-doc parameter typo for IRQCHIP

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]

Date:   Tue, 28 Sep 2021 21:41:29 +0300
From:   Sergey Shtylyov <s.shtylyov@....ru>
To:     Florian Fainelli <f.fainelli@...il.com>,
        <linux-kernel@...r.kernel.org>
CC:     Ray Jui <rjui@...adcom.com>, Scott Branden <sbranden@...adcom.com>,
        "maintainer:BROADCOM BCM281XX/BCM11XXX/BCM216XX ARM ARCHITE..." 
        <bcm-kernel-feedback-list@...adcom.com>,
        Russell King <linux@...linux.org.uk>,
        Catalin Marinas <catalin.marinas@....com>,
        "Will Deacon" <will@...nel.org>,
        Thomas Bogendoerfer <tsbogend@...ha.franken.de>,
        Thomas Gleixner <tglx@...utronix.de>,
        Marc Zyngier <maz@...nel.org>,
        "Rob Herring" <robh+dt@...nel.org>,
        Frank Rowand <frowand.list@...il.com>,
        "moderated list:ARM SUB-ARCHITECTURES" 
        <linux-arm-kernel@...ts.infradead.org>,
        "open list:MIPS" <linux-mips@...r.kernel.org>,
        "open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE" 
        <devicetree@...r.kernel.org>
Subject: Re: [PATCH v3 14/14] irqchip: Fix kernel-doc parameter typo for
 IRQCHIP_DECLARE

On 9/28/21 9:21 PM, Florian Fainelli wrote:

> The documentation refers to "compstr" when we have the argument named

   Nitpick: the arguments are what you pass to a function, you meant parameters.

> "compat", fix the typo.
> 
> Signed-off-by: Florian Fainelli <f.fainelli@...il.com>
> ---
>  include/linux/irqchip.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/irqchip.h b/include/linux/irqchip.h
> index 67351aac65ef..ccf32758ea85 100644
> --- a/include/linux/irqchip.h
> +++ b/include/linux/irqchip.h
> @@ -23,7 +23,7 @@
>   *
>   * @name: name that must be unique across all IRQCHIP_DECLARE of the
>   * same file.
> - * @compstr: compatible string of the irqchip driver
> + * @compat: compatible string of the irqchip driver
>   * @fn: initialization function
>   */
>  #define IRQCHIP_DECLARE(name, compat, fn) OF_DECLARE_2(irqchip, name, compat, fn)

MBR. Sergey