mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mirsad Todorovac <mtodorovac69@gmail.com>
To: Dmitry Torokhov <dmitry.torokhov@gmail.com>, linux-input@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Input: twl4030-pwrbutton - fix kernel-doc warning
Date: Thu, 11 Jul 2024 18:48:53 +0200	[thread overview]
Message-ID: <3ac07aff-4ac4-4649-86ec-6175dd516162@gmail.com> (raw)
In-Reply-To: <Zo3QE00GqCrA3M9b@google.com>

On 7/10/24 02:04, Dmitry Torokhov wrote:
> Do not use kernel-doc style for comment describing contents of the
> source file, as it trips the script:
> 
>   scripts/kernel-doc -none   drivers/input/misc/twl4030-pwrbutton.c
> drivers/input/misc/twl4030-pwrbutton.c:2: info: Scanning doc for function twl4030
> drivers/input/misc/twl4030-pwrbutton.c:33: warning: expecting prototype for twl4030(). Prototype was for PWR_PWRON_IRQ() instead
> 1 warnings
> 
> Also remove file name from the same comment - it it not the best idea
> to have it as they tend to get stale when sources get moved or renamed.
> 
> Reported-by: Mirsad Todorovac <mtodorovac69@gmail.com>
> Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> ---
>  drivers/input/misc/twl4030-pwrbutton.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/input/misc/twl4030-pwrbutton.c b/drivers/input/misc/twl4030-pwrbutton.c
> index e3ee0638ffba..f85cc289c053 100644
> --- a/drivers/input/misc/twl4030-pwrbutton.c
> +++ b/drivers/input/misc/twl4030-pwrbutton.c
> @@ -1,5 +1,5 @@
> -/**
> - * twl4030-pwrbutton.c - TWL4030 Power Button Input Driver
> +/*
> + * TWL4030 Power Button Input Driver
>   *
>   * Copyright (C) 2008-2009 Nokia Corporation
>   *

Tested, finally:

  CC      drivers/input/misc/tps65219-pwrbutton.o
  CC      drivers/input/misc/twl4030-pwrbutton.o
  CC      drivers/hwmon/pmbus/max15301.o

Compiled w/o warnings.

Thanks!

Tested-by: Mirsad Todorovac <mtodorovac69@gmail.com>

Best regards,
Mirsad Todorovac

      reply	other threads:[~2024-07-11 16:48 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-10  0:04 Dmitry Torokhov
2024-07-11 16:48 ` Mirsad Todorovac [this message]

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=3ac07aff-4ac4-4649-86ec-6175dd516162@gmail.com \
    --to=mtodorovac69@gmail.com \
    --cc=dmitry.torokhov@gmail.com \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®