[PATCH 3/3] batman-adv: Add missing kerneldoc for extack

[PATCH 3/3] batman-adv: Add missing kerneldoc for extack

[Sven Eckelmann]

The parameter extack was added to batadv_softif_slave_add without adding
the kernel-doc for it. This caused kernel-doc warnings.

Signed-off-by: Sven Eckelmann <sven-KaDOiPu9UxWEi8DpZVb4nw@public.gmane.org>
Cc: David Ahern <dsahern-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
---
 net/batman-adv/soft-interface.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/net/batman-adv/soft-interface.c b/net/batman-adv/soft-interface.c
index 543d2c3e..9f673cdf 100644
--- a/net/batman-adv/soft-interface.c
+++ b/net/batman-adv/soft-interface.c
@@ -863,6 +863,7 @@ static int batadv_softif_init_late(struct net_device *dev)
  * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface
  * @dev: batadv_soft_interface used as master interface
  * @slave_dev: net_device which should become the slave interface
+ * @extack: extended ACK report struct
  *
  * Return: 0 if successful or error otherwise.
  */
-- 
2.11.0

Re: [PATCH 3/3] batman-adv: Add missing kerneldoc for extack

[David Ahern]

On 10/7/17 6:21 AM, Sven Eckelmann wrote:
> The parameter extack was added to batadv_softif_slave_add without adding
> the kernel-doc for it. This caused kernel-doc warnings.
> 
> Signed-off-by: Sven Eckelmann <sven@narfation.org>
> Cc: David Ahern <dsahern@gmail.com>
> ---
>  net/batman-adv/soft-interface.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/net/batman-adv/soft-interface.c b/net/batman-adv/soft-interface.c
> index 543d2c3e..9f673cdf 100644
> --- a/net/batman-adv/soft-interface.c
> +++ b/net/batman-adv/soft-interface.c
> @@ -863,6 +863,7 @@ static int batadv_softif_init_late(struct net_device *dev)
>   * batadv_softif_slave_add - Add a slave interface to a batadv_soft_interface
>   * @dev: batadv_soft_interface used as master interface
>   * @slave_dev: net_device which should become the slave interface
> + * @extack: extended ACK report struct
>   *
>   * Return: 0 if successful or error otherwise.
>   */
> 

Thanks for the cleanup.

Acked-by: David Ahern <dsahern@gmail.com>

Re: [PATCH 3/3] batman-adv: Add missing kerneldoc for extack

[David Miller]

From: Sven Eckelmann <sven@narfation.org>
Date: Sat,  7 Oct 2017 14:21:22 +0200

> The parameter extack was added to batadv_softif_slave_add without adding
> the kernel-doc for it. This caused kernel-doc warnings.
> 
> Signed-off-by: Sven Eckelmann <sven@narfation.org>
> Cc: David Ahern <dsahern@gmail.com>

I'm happy to apply this but where are the other two patches of this
series and the series header posting?

Re: [PATCH 3/3] batman-adv: Add missing kerneldoc for extack

[Sven Eckelmann]

[-- Attachment #1: Type: text/plain, Size: 2369 bytes --]

On Samstag, 7. Oktober 2017 20:59:52 CEST David Miller wrote:
> From: Sven Eckelmann <sven@narfation.org>
> Date: Sat,  7 Oct 2017 14:21:22 +0200
> 
> > The parameter extack was added to batadv_softif_slave_add without adding
> > the kernel-doc for it. This caused kernel-doc warnings.
> > 
> > Signed-off-by: Sven Eckelmann <sven@narfation.org>
> > Cc: David Ahern <dsahern@gmail.com>
> 
> I'm happy to apply this but where are the other two patches of this
> series and the series header posting?

They are on the b.a.t.m.a.n@lists.open-mesh.org mailing list. And they deal 
with the "extack" compat problems of the out-of-tree module build.

Why were you cc'ed for the patch 3:
==================================

David Ahern and David Miller were involved in adding following changes to 
batman-adv:

* net: Add extack to ndo_add_slave
* net: Add extack to upper device linking

These were not posted to the batman-adv mailing list.

An automatic kernel-doc run on a build machine noticed a minor problem in the 
first patch. Since I was not involved in the original change (and have not 
checked what was discussed in the past about it), I could only guess how the 
kernel-doc should have looked like. But you, David Ahern or anyone else from 
netdev@... could have a different, more educated opinion about the correct 
documentation - this is why you were Cc'ed.


Why are you not Cc'ed on the patch 1+2:
======================================

The changes are about code which is not present in the upstream kernel. It 
only deals with changes required to build the extracted batman-adv module 
against a different kernel. These changes were required to get the "extack" 
stuff working on Linux 4.14 and below.

So, it is not really relevant for you but for some people on the 
b.a.t.m.a.n@lists.open-mesh.org mailing list. This is why everything 
(including the third patch) was send directly ("To:") to the mentioned mailing 
list.


Are you expected to apply this change:
=====================================

I was hoping that Simon is picking the patch up and forwards it do you in a 
proper pull request. But I would doubt that he has a big problem with you 
applying this single line kernel-doc change. At least it is less work for him 
and less extra noise on both mailing lists...

But feel free to tell us your preferred solution.

Kind regards,
	Sven

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH 3/3] batman-adv: Add missing kerneldoc for extack

[David Miller]

From: Sven Eckelmann <sven@narfation.org>
Date: Sun, 08 Oct 2017 09:29:17 +0200

> Are you expected to apply this change:
> =====================================
> 
> I was hoping that Simon is picking the patch up and forwards it do you in a 
> proper pull request. But I would doubt that he has a big problem with you 
> applying this single line kernel-doc change. At least it is less work for him 
> and less extra noise on both mailing lists...
> 
> But feel free to tell us your preferred solution.

Ok I'll wait to get this from the next batman-adv pull request then.

Thanks.