mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Guenter Roeck <linux@roeck-us.net>
To: Babanpreet Singh <bbnpreetsingh@gmail.com>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>,
	Madhavan Srinivasan <maddy@linux.ibm.com>,
	Michael Ellerman <mpe@ellerman.id.au>,
	Nicholas Piggin <npiggin@gmail.com>,
	Christophe Leroy <chleroy@kernel.org>,
	linuxppc-dev@lists.ozlabs.org, linux-watchdog@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/2] watchdog: wdrtas: Fix kernel-doc parameter name for wdrtas_reboot()
Date: Thu, 6 Aug 2026 14:32:26 -0700	[thread overview]
Message-ID: <cb17b508-71fe-4c74-bdc2-58d622b7eef5@roeck-us.net> (raw)
In-Reply-To: <20260730060617.7-2-bbnpreetsingh@gmail.com>

On Thu, Jul 30, 2026 at 06:06:16AM +0000, Babanpreet Singh wrote:
> scripts/kernel-doc -none reports:
> 
>   Warning: drivers/watchdog/wdrtas.c:460 function parameter 'this' not
>   described in 'wdrtas_reboot'
>   Warning: drivers/watchdog/wdrtas.c:460 Excess function parameter 'nb'
>   description in 'wdrtas_reboot'
> 
> wdrtas_reboot() names its notifier block argument 'this', but the
> kernel-doc comment documents a parameter named 'nb'.
> 
> Update the kernel-doc comment to document the 'this' parameter.
> 
> Assisted-by: Claude:claude-opus-5
> Signed-off-by: Babanpreet Singh <bbnpreetsingh@gmail.com>

This is a 20+ years old driver which doesn't use the watchdog subsystem.
I am not going to apply any patches to it unless the author shows that
it is a real problem observed on real hardware, and then I am likely
going to ask for a conversion to the watchdog subsystem unlesss it is
a critical aproblem and not just something AI came up with as a possible
issue.

Guenter

> ---
>  drivers/watchdog/wdrtas.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/watchdog/wdrtas.c b/drivers/watchdog/wdrtas.c
> index d4fe0bc822116..6c25171de224e 100644
> --- a/drivers/watchdog/wdrtas.c
> +++ b/drivers/watchdog/wdrtas.c
> @@ -448,7 +448,7 @@ static int wdrtas_temp_close(struct inode *inode, struct file *file)
>  
>  /**
>   * wdrtas_reboot - reboot notifier function
> - * @nb: notifier block structure
> + * @this: notifier block structure
>   * @code: reboot code
>   * @ptr: unused
>   *

  reply	other threads:[~2026-08-06 21:32 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-30  6:06 [PATCH 0/2] watchdog: Fix two kernel-doc parameter warnings Babanpreet Singh
2026-07-30  6:06 ` [PATCH 1/2] watchdog: wdrtas: Fix kernel-doc parameter name for wdrtas_reboot() Babanpreet Singh
2026-08-06 21:32   ` Guenter Roeck [this message]
2026-07-30  6:06 ` [PATCH 2/2] watchdog: booke_wdt: Document unused parameter of __booke_wdt_disable() Babanpreet Singh
2026-08-06 21:28   ` Guenter Roeck

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=cb17b508-71fe-4c74-bdc2-58d622b7eef5@roeck-us.net \
    --to=linux@roeck-us.net \
    --cc=bbnpreetsingh@gmail.com \
    --cc=chleroy@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-watchdog@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=maddy@linux.ibm.com \
    --cc=mpe@ellerman.id.au \
    --cc=npiggin@gmail.com \
    --cc=wim@linux-watchdog.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®