linux-kernel - Re: [PATCH] net: add missing descriptions in net_device_priv

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <56F0612E.20607@osg.samsung.com>
Date:	Mon, 21 Mar 2016 21:01:34 +0000
From:	Luis de Bethencourt <luisbg@....samsung.com>
To:	Benjamin Poirier <benjamin.poirier@...il.com>
CC:	linux-kernel@...r.kernel.org, davem@...emloft.net,
	netdev@...r.kernel.org, Eric Dumazet <edumazet@...gle.com>
Subject: Re: [PATCH] net: add missing descriptions in net_device_priv_flags

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@....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
>>