* [PATCH] net: add missing descriptions in net_device_priv_flags
@ 2016-03-21 20:20 Luis de Bethencourt
2016-03-21 20:41 ` Benjamin Poirier
0 siblings, 1 reply; 6+ messages in thread
From: Luis de Bethencourt @ 2016-03-21 20:20 UTC (permalink / raw)
To: linux-kernel; +Cc: davem, netdev, Luis de Bethencourt
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
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH] net: add missing descriptions in net_device_priv_flags
2016-03-21 20:20 [PATCH] net: add missing descriptions in net_device_priv_flags Luis de Bethencourt
@ 2016-03-21 20:41 ` Benjamin Poirier
2016-03-21 21:01 ` Luis de Bethencourt
0 siblings, 1 reply; 6+ messages in thread
From: Benjamin Poirier @ 2016-03-21 20:41 UTC (permalink / raw)
To: Luis de Bethencourt; +Cc: linux-kernel, davem, netdev, Eric Dumazet
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
>
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH] net: add missing descriptions in net_device_priv_flags
2016-03-21 20:41 ` Benjamin Poirier
@ 2016-03-21 21:01 ` Luis de Bethencourt
2016-03-21 21:08 ` [PATCH] net: Add missing kernel-doc for netdev ptype lists Benjamin Poirier
0 siblings, 1 reply; 6+ messages in thread
From: Luis de Bethencourt @ 2016-03-21 21:01 UTC (permalink / raw)
To: Benjamin Poirier; +Cc: linux-kernel, davem, netdev, Eric Dumazet
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
>>
^ permalink raw reply [flat|nested] 6+ messages in thread* [PATCH] net: Add missing kernel-doc for netdev ptype lists
2016-03-21 21:01 ` Luis de Bethencourt
@ 2016-03-21 21:08 ` Benjamin Poirier
2016-03-21 21:47 ` Luis de Bethencourt
2016-03-22 2:58 ` David Miller
0 siblings, 2 replies; 6+ messages in thread
From: Benjamin Poirier @ 2016-03-21 21:08 UTC (permalink / raw)
To: netdev; +Cc: Luis de Bethencourt, Salam Noureddine
.//include/linux/netdevice.h:1826: warning: No description found for parameter 'ptype_all'
.//include/linux/netdevice.h:1826: warning: No description found for parameter 'ptype_specific'
Introduced by commit 7866a621043f ("dev: add per net_device packet type
chains")
Cc: Salam Noureddine <noureddine@arista.com>
Signed-off-by: Benjamin Poirier <bpoirier@suse.com>
---
include/linux/netdevice.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index 9a3d55c..1937bdd 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -1418,6 +1418,8 @@ enum netdev_priv_flags {
* @unreg_list: List entry, that is used, when we are unregistering the
* device, see the function unregister_netdev
* @close_list: List entry, that is used, when we are closing the device
+ * @ptype_all: Device-specific packet handlers for all protocols
+ * @ptype_specific: Device-specific, protocol-specific packet handlers
*
* @adj_list: Directly linked devices, like slaves for bonding
* @all_adj_list: All linked devices, *including* neighbours
--
2.7.2
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH] net: Add missing kernel-doc for netdev ptype lists
2016-03-21 21:08 ` [PATCH] net: Add missing kernel-doc for netdev ptype lists Benjamin Poirier
@ 2016-03-21 21:47 ` Luis de Bethencourt
2016-03-22 2:58 ` David Miller
1 sibling, 0 replies; 6+ messages in thread
From: Luis de Bethencourt @ 2016-03-21 21:47 UTC (permalink / raw)
To: Benjamin Poirier, netdev; +Cc: Salam Noureddine
On 21/03/16 21:08, Benjamin Poirier wrote:
> .//include/linux/netdevice.h:1826: warning: No description found for parameter 'ptype_all'
> .//include/linux/netdevice.h:1826: warning: No description found for parameter 'ptype_specific'
>
> Introduced by commit 7866a621043f ("dev: add per net_device packet type
> chains")
>
> Cc: Salam Noureddine <noureddine@arista.com>
> Signed-off-by: Benjamin Poirier <bpoirier@suse.com>
> ---
> include/linux/netdevice.h | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
> index 9a3d55c..1937bdd 100644
> --- a/include/linux/netdevice.h
> +++ b/include/linux/netdevice.h
> @@ -1418,6 +1418,8 @@ enum netdev_priv_flags {
> * @unreg_list: List entry, that is used, when we are unregistering the
> * device, see the function unregister_netdev
> * @close_list: List entry, that is used, when we are closing the device
> + * @ptype_all: Device-specific packet handlers for all protocols
> + * @ptype_specific: Device-specific, protocol-specific packet handlers
> *
> * @adj_list: Directly linked devices, like slaves for bonding
> * @all_adj_list: All linked devices, *including* neighbours
>
Looks good to me.
Thanks Benjamin :)
Luis
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH] net: Add missing kernel-doc for netdev ptype lists
2016-03-21 21:08 ` [PATCH] net: Add missing kernel-doc for netdev ptype lists Benjamin Poirier
2016-03-21 21:47 ` Luis de Bethencourt
@ 2016-03-22 2:58 ` David Miller
1 sibling, 0 replies; 6+ messages in thread
From: David Miller @ 2016-03-22 2:58 UTC (permalink / raw)
To: bpoirier; +Cc: netdev, luisbg, noureddine
From: Benjamin Poirier <bpoirier@suse.com>
Date: Mon, 21 Mar 2016 14:08:28 -0700
> .//include/linux/netdevice.h:1826: warning: No description found for parameter 'ptype_all'
> .//include/linux/netdevice.h:1826: warning: No description found for parameter 'ptype_specific'
>
> Introduced by commit 7866a621043f ("dev: add per net_device packet type
> chains")
>
> Cc: Salam Noureddine <noureddine@arista.com>
> Signed-off-by: Benjamin Poirier <bpoirier@suse.com>
Applied.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2016-03-22 2:58 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-03-21 20:20 [PATCH] net: add missing descriptions in net_device_priv_flags Luis de Bethencourt
2016-03-21 20:41 ` Benjamin Poirier
2016-03-21 21:01 ` Luis de Bethencourt
2016-03-21 21:08 ` [PATCH] net: Add missing kernel-doc for netdev ptype lists Benjamin Poirier
2016-03-21 21:47 ` Luis de Bethencourt
2016-03-22 2:58 ` David Miller
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).