Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1362137 > unrolled thread

[PATCH] net: add missing descriptions in net_device_priv_flags

Started byLuis de Bethencourt <luisbg@osg.samsung.com>
First post2016-03-21 21:30 +0100
Last post2016-03-21 22:10 +0100
Articles 3 — 2 participants

Back to article view | Back to linux.kernel


Contents

  [PATCH] net: add missing descriptions in net_device_priv_flags Luis de Bethencourt <luisbg@osg.samsung.com> - 2016-03-21 21:30 +0100
    Re: [PATCH] net: add missing descriptions in net_device_priv_flags Benjamin Poirier <benjamin.poirier@gmail.com> - 2016-03-21 21:50 +0100
      Re: [PATCH] net: add missing descriptions in net_device_priv_flags Luis de Bethencourt <luisbg@osg.samsung.com> - 2016-03-21 22:10 +0100

#1362137 — [PATCH] net: add missing descriptions in net_device_priv_flags

FromLuis de Bethencourt <luisbg@osg.samsung.com>
Date2016-03-21 21:30 +0100
Subject[PATCH] net: add missing descriptions in net_device_priv_flags
Message-ID<rfeCC-2iV-13@gated-at.bofh.it>
The flags IFF_XMIT_DST_RELEASE_PERM, IFF_IPVLAN_MASTER and
IFF_IPVLAN_SLAVE are missing descriptions for the Documentation. Adding
them.

Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
---
Hi,

I also noticed this issue when running make htmldocs. Having better
documentation is great :)

Thanks,
Luis

 include/linux/netdevice.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index be693b3..db9ffe4 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1320,6 +1320,9 @@ struct net_device_ops {
  * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
  *	change when it's running
  * @IFF_MACVLAN: Macvlan device
+ * @IFF_XMIT_DST_RELEASE_PERM: permanent IFF_XMIT_DST_RELEASE
+ * @IFF_IPVLAN_MASTER: IPvlan master device
+ * @IFF_IPVLAN_SLAVE: IPvlan slave device
  * @IFF_L3MDEV_MASTER: device is an L3 master device
  * @IFF_NO_QUEUE: device can run without qdisc attached
  * @IFF_OPENVSWITCH: device is a Open vSwitch master
-- 
2.5.1

[toc] | [next] | [standalone]


#1362142

FromBenjamin Poirier <benjamin.poirier@gmail.com>
Date2016-03-21 21:50 +0100
Message-ID<rfeVY-2so-3@gated-at.bofh.it>
In reply to#1362137
On 2016/03/21 20:20, Luis de Bethencourt wrote:
> The flags IFF_XMIT_DST_RELEASE_PERM, IFF_IPVLAN_MASTER and
> IFF_IPVLAN_SLAVE are missing descriptions for the Documentation. Adding
> them.
> 
> Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
> ---
> Hi,
> 
> I also noticed this issue when running make htmldocs. Having better
> documentation is great :)
> 
> Thanks,
> Luis
> 
>  include/linux/netdevice.h | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
> index be693b3..db9ffe4 100644
> --- a/include/linux/netdevice.h
> +++ b/include/linux/netdevice.h
> @@ -1320,6 +1320,9 @@ struct net_device_ops {
>   * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
>   *	change when it's running
>   * @IFF_MACVLAN: Macvlan device
> + * @IFF_XMIT_DST_RELEASE_PERM: permanent IFF_XMIT_DST_RELEASE

I also noticed these kernel-doc warnings and had some patches queued for
them. May I suggest the following in this case:

 * @IFF_XMIT_DST_RELEASE_PERM: IFF_XMIT_DST_RELEASE not taking into account
 * 	underlying stacked devices

I presume that a patch for netdev ptype lists is forthcoming. Here's
what I had:

 *	@ptype_all:     Device-specific packet handlers for all protocols
 *	@ptype_specific: Device-specific, protocol-specific packet handlers

> + * @IFF_IPVLAN_MASTER: IPvlan master device
> + * @IFF_IPVLAN_SLAVE: IPvlan slave device
>   * @IFF_L3MDEV_MASTER: device is an L3 master device
>   * @IFF_NO_QUEUE: device can run without qdisc attached
>   * @IFF_OPENVSWITCH: device is a Open vSwitch master
> -- 
> 2.5.1
> 

[toc] | [prev] | [next] | [standalone]


#1362151

FromLuis de Bethencourt <luisbg@osg.samsung.com>
Date2016-03-21 22:10 +0100
Message-ID<rfffk-2ON-17@gated-at.bofh.it>
In reply to#1362142
On 21/03/16 20:41, Benjamin Poirier wrote:
> On 2016/03/21 20:20, Luis de Bethencourt wrote:
>> The flags IFF_XMIT_DST_RELEASE_PERM, IFF_IPVLAN_MASTER and
>> IFF_IPVLAN_SLAVE are missing descriptions for the Documentation. Adding
>> them.
>>
>> Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
>> ---
>> Hi,
>>
>> I also noticed this issue when running make htmldocs. Having better
>> documentation is great :)
>>
>> Thanks,
>> Luis
>>
>>  include/linux/netdevice.h | 3 +++
>>  1 file changed, 3 insertions(+)
>>
>> diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
>> index be693b3..db9ffe4 100644
>> --- a/include/linux/netdevice.h
>> +++ b/include/linux/netdevice.h
>> @@ -1320,6 +1320,9 @@ struct net_device_ops {
>>   * @IFF_LIVE_ADDR_CHANGE: device supports hardware address
>>   *	change when it's running
>>   * @IFF_MACVLAN: Macvlan device
>> + * @IFF_XMIT_DST_RELEASE_PERM: permanent IFF_XMIT_DST_RELEASE
> 
> I also noticed these kernel-doc warnings and had some patches queued for
> them. May I suggest the following in this case:
> 
>  * @IFF_XMIT_DST_RELEASE_PERM: IFF_XMIT_DST_RELEASE not taking into account
>  * 	underlying stacked devices
> 
> I presume that a patch for netdev ptype lists is forthcoming. Here's
> what I had:
> 
>  *	@ptype_all:     Device-specific packet handlers for all protocols
>  *	@ptype_specific: Device-specific, protocol-specific packet handlers
>

Hi Benjamin,

I was going to submit the fix for ptype_all and ptype_specific next, but your
descriptions are better. You should do it instead or if you want me to, I can
do it but amending you as the Author of the commit. Attribution where it is
deserved.

Thanks for looking into this,
Luis
 
>> + * @IFF_IPVLAN_MASTER: IPvlan master device
>> + * @IFF_IPVLAN_SLAVE: IPvlan slave device
>>   * @IFF_L3MDEV_MASTER: device is an L3 master device
>>   * @IFF_NO_QUEUE: device can run without qdisc attached
>>   * @IFF_OPENVSWITCH: device is a Open vSwitch master
>> -- 
>> 2.5.1
>>

[toc] | [prev] | [standalone]


Back to top | Article view | linux.kernel


csiph-web