diff mbox series

[1/3] net: fix a new kernel-doc warning at dev.c

Message ID dbe62eb5e9dda5a5ee145f866a24c4cfddbd754f.1600773619.git.mchehab+huawei@kernel.org
State New
Headers show
Series [1/3] net: fix a new kernel-doc warning at dev.c | expand

Commit Message

Mauro Carvalho Chehab Sept. 22, 2020, 11:22 a.m. UTC
kernel-doc expects the function prototype to be just after
the kernel-doc markup, as otherwise it will get it all wrong:

	./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'

Fixes: 0e4be9e57e8c ("net: use exponential backoff in netdev_wait_allrefs")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 net/core/dev.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Francesco Ruggeri Sept. 22, 2020, 5:48 p.m. UTC | #1
On Tue, Sep 22, 2020 at 4:22 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>

> kernel-doc expects the function prototype to be just after

> the kernel-doc markup, as otherwise it will get it all wrong:

>

>         ./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'

>

> Fixes: 0e4be9e57e8c ("net: use exponential backoff in netdev_wait_allrefs")

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

> ---

>  net/core/dev.c | 4 ++--

>  1 file changed, 2 insertions(+), 2 deletions(-)

>

> diff --git a/net/core/dev.c b/net/core/dev.c

> index a268ff35ad38..873b50ac9668 100644

> --- a/net/core/dev.c

> +++ b/net/core/dev.c

> @@ -10021,6 +10021,8 @@ int netdev_refcnt_read(const struct net_device *dev)

>  }

>  EXPORT_SYMBOL(netdev_refcnt_read);

>

> +#define WAIT_REFS_MIN_MSECS 1

> +#define WAIT_REFS_MAX_MSECS 250

>  /**

>   * netdev_wait_allrefs - wait until all references are gone.

>   * @dev: target net_device

> @@ -10033,8 +10035,6 @@ EXPORT_SYMBOL(netdev_refcnt_read);

>   * We can get stuck here if buggy protocols don't correctly

>   * call dev_put.

>   */

> -#define WAIT_REFS_MIN_MSECS 1

> -#define WAIT_REFS_MAX_MSECS 250

>  static void netdev_wait_allrefs(struct net_device *dev)

>  {

>         unsigned long rebroadcast_time, warning_time;

> --

> 2.26.2

>
Francesco Ruggeri Sept. 22, 2020, 5:50 p.m. UTC | #2
On Tue, Sep 22, 2020 at 4:22 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> kernel-doc expects the function prototype to be just after
> the kernel-doc markup, as otherwise it will get it all wrong:
>
>         ./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'
>
> Fixes: 0e4be9e57e8c ("net: use exponential backoff in netdev_wait_allrefs")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Reviewed-by: Francesco Ruggeri <fruggeri@arista.com>

Thanks for fixing this!
David Miller Sept. 24, 2020, 12:43 a.m. UTC | #3
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Date: Tue, 22 Sep 2020 13:22:52 +0200

> kernel-doc expects the function prototype to be just after
> the kernel-doc markup, as otherwise it will get it all wrong:
> 
> 	./net/core/dev.c:10036: warning: Excess function parameter 'dev' description in 'WAIT_REFS_MIN_MSECS'
> 
> Fixes: 0e4be9e57e8c ("net: use exponential backoff in netdev_wait_allrefs")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Applied to net-next.
diff mbox series

Patch

diff --git a/net/core/dev.c b/net/core/dev.c
index a268ff35ad38..873b50ac9668 100644
--- a/net/core/dev.c
+++ b/net/core/dev.c
@@ -10021,6 +10021,8 @@  int netdev_refcnt_read(const struct net_device *dev)
 }
 EXPORT_SYMBOL(netdev_refcnt_read);
 
+#define WAIT_REFS_MIN_MSECS 1
+#define WAIT_REFS_MAX_MSECS 250
 /**
  * netdev_wait_allrefs - wait until all references are gone.
  * @dev: target net_device
@@ -10033,8 +10035,6 @@  EXPORT_SYMBOL(netdev_refcnt_read);
  * We can get stuck here if buggy protocols don't correctly
  * call dev_put.
  */
-#define WAIT_REFS_MIN_MSECS 1
-#define WAIT_REFS_MAX_MSECS 250
 static void netdev_wait_allrefs(struct net_device *dev)
 {
 	unsigned long rebroadcast_time, warning_time;