diff mbox series

[v3,14/14] irqchip: Fix kernel-doc parameter typo for IRQCHIP_DECLARE

Message ID 20210928182139.652896-15-f.fainelli@gmail.com (mailing list archive)
State Superseded
Headers show
Series Modular Broadcom irqchip drivers | expand

Commit Message

Florian Fainelli Sept. 28, 2021, 6:21 p.m. UTC
The documentation refers to "compstr" when we have the argument named
"compat", fix the typo.

Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
---
 include/linux/irqchip.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Sergey Shtylyov Sept. 28, 2021, 6:41 p.m. UTC | #1
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@gmail.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
diff mbox series

Patch

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)