public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Guenter Roeck <linux@roeck-us.net>
To: Dan Carpenter <dan.carpenter@oracle.com>,
	Wim Van Sebroeck <wim@iguana.be>
Cc: linux-watchdog@vger.kernel.org, linux-kernel@vger.kernel.org,
	kernel-janitors@vger.kernel.org
Subject: Re: [patch] watchdog: pnx833x_wdt: fix typo in MODULE_PARM_DESC
Date: Fri, 8 Jan 2016 06:49:09 -0800	[thread overview]
Message-ID: <568FCC65.6010106@roeck-us.net> (raw)
In-Reply-To: <20160108110239.GI32195@mwanda>

On 01/08/2016 03:02 AM, Dan Carpenter wrote:
> The module_param() is "pnx833x_wdt_timeout" and MODULE_PARM_DESC()
> should match.
>
> Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
>
> diff --git a/drivers/watchdog/pnx833x_wdt.c b/drivers/watchdog/pnx833x_wdt.c
> index 882fdcb..69da25a 100644
> --- a/drivers/watchdog/pnx833x_wdt.c
> +++ b/drivers/watchdog/pnx833x_wdt.c
> @@ -52,8 +52,9 @@ static int pnx833x_wdt_alive;
>   /* Set default timeout in MHZ.*/
>   static int pnx833x_wdt_timeout = PNX_WATCHDOG_TIMEOUT;
>   module_param(pnx833x_wdt_timeout, int, 0);
> -MODULE_PARM_DESC(timeout, "Watchdog timeout in Mhz. (68Mhz clock), default="
> -			__MODULE_STRING(PNX_TIMEOUT_VALUE) "(30 seconds).");
> +MODULE_PARM_DESC(pnx833x_wdt_timeout,
> +		 "Watchdog timeout in Mhz. (68Mhz clock), default="
> +		 __MODULE_STRING(PNX_TIMEOUT_VALUE) "(30 seconds).");

The intent here was to have a module parameter named 'timeout'.
Of course that was never the case. Wonder if anyone ever noticed.
The correct fix would be to use something like
	module_param_named(timeout, pnx833x_wdt_timeout, int, 0);
but of course that would change the ABI. On the other side,
'timeout' is the documented module parameter in
Documentation/watchdog/watchdog-parameters.txt, so one could argue
that using module_param_named() would be a bug fix and not an ABI change.

Not really sure what the best approach is here. Wim, any comments ?
Provide module_param_named() in _addition_ to the existing module_param(),
maybe, if that is possible ?

Guenter

  reply	other threads:[~2016-01-08 14:49 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-08 11:02 [patch] watchdog: pnx833x_wdt: fix typo in MODULE_PARM_DESC Dan Carpenter
2016-01-08 14:49 ` Guenter Roeck [this message]
2016-01-11 21:42   ` Wim Van Sebroeck
2016-03-06 20:33   ` Wim Van Sebroeck

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=568FCC65.6010106@roeck-us.net \
    --to=linux@roeck-us.net \
    --cc=dan.carpenter@oracle.com \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-watchdog@vger.kernel.org \
    --cc=wim@iguana.be \
    /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