[01/15] leds: trigger: ledtrig-cpu: Fix incorrectly documented param 'ledevt'

Message ID 20210528090629.1800173-2-lee.jones@linaro.org
State New
Headers show
Series
  • Rid W=1 warnings from LED
Related show

Commit Message

Lee Jones May 28, 2021, 9:06 a.m.
Fixes the following W=1 kernel build warning(s):

 drivers/leds/trigger/ledtrig-cpu.c:52: warning: Function parameter or member 'ledevt' not described in 'ledtrig_cpu'
 drivers/leds/trigger/ledtrig-cpu.c:52: warning: Excess function parameter 'evt' description in 'ledtrig_cpu'

Cc: Pavel Machek <pavel@ucw.cz>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Bryan Wu <bryan.wu@canonical.com>
Cc: linux-leds@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/leds/trigger/ledtrig-cpu.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.31.1

Comments

Alexander Dahl May 28, 2021, 10:03 a.m. | #1
Hello,

Am Freitag, 28. Mai 2021, 11:06:15 CEST schrieb Lee Jones:
> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/leds/trigger/ledtrig-cpu.c:52: warning: Function parameter or

> member 'ledevt' not described in 'ledtrig_cpu'

> drivers/leds/trigger/ledtrig-cpu.c:52: warning: Excess function parameter

> 'evt' description in 'ledtrig_cpu'

> 

> Cc: Pavel Machek <pavel@ucw.cz>

> Cc: Linus Walleij <linus.walleij@linaro.org>

> Cc: Bryan Wu <bryan.wu@canonical.com>

> Cc: linux-leds@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/leds/trigger/ledtrig-cpu.c | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/drivers/leds/trigger/ledtrig-cpu.c

> b/drivers/leds/trigger/ledtrig-cpu.c index fca62d5035909..8af4f9bb9cde8

> 100644

> --- a/drivers/leds/trigger/ledtrig-cpu.c

> +++ b/drivers/leds/trigger/ledtrig-cpu.c

> @@ -43,7 +43,7 @@ static atomic_t num_active_cpus = ATOMIC_INIT(0);

> 

>  /**

>   * ledtrig_cpu - emit a CPU event as a trigger

> - * @evt: CPU event to be emitted

> + * @ledevt: CPU event to be emitted

>   *

>   * Emit a CPU event on a CPU core, which will trigger a

>   * bound LED to turn on or turn off.


Reviewed-by: Alexander Dahl <ada@thorsis.com>


Greets
Alex

Patch

diff --git a/drivers/leds/trigger/ledtrig-cpu.c b/drivers/leds/trigger/ledtrig-cpu.c
index fca62d5035909..8af4f9bb9cde8 100644
--- a/drivers/leds/trigger/ledtrig-cpu.c
+++ b/drivers/leds/trigger/ledtrig-cpu.c
@@ -43,7 +43,7 @@  static atomic_t num_active_cpus = ATOMIC_INIT(0);
 
 /**
  * ledtrig_cpu - emit a CPU event as a trigger
- * @evt: CPU event to be emitted
+ * @ledevt: CPU event to be emitted
  *
  * Emit a CPU event on a CPU core, which will trigger a
  * bound LED to turn on or turn off.