Re: [PATCH] net: kdoc struct net_device flags and priv_flags

["Luis R. Rodriguez" <mcgrof@suse.com>]

On Mon, Feb 24, 2014 at 09:37:34PM -0800, Florian Fainelli wrote:
> Le lundi 24 février 2014, 23:53:43 David Miller a écrit :
> > From: Ben Hutchings <ben@decadent.org.uk>
> > Date: Tue, 25 Feb 2014 02:11:05 +0000
> > 
> > > On Mon, 2014-02-24 at 16:14 -0800, Luis R. Rodriguez wrote:
> > >> From: "Luis R. Rodriguez" <mcgrof@suse.com>
> > >> 
> > >> ---
> > >> 
> > >>  include/uapi/linux/if.h | 201
> > >>  +++++++++++++++++++++++++++++++++++------------- 1 file changed, 149
> > >>  insertions(+), 52 deletions(-)
> > >> 
> > >> diff --git a/include/uapi/linux/if.h b/include/uapi/linux/if.h
> > >> index d758163..1555623 100644
> > >> --- a/include/uapi/linux/if.h
> > >> +++ b/include/uapi/linux/if.h
> > > 
> > > [...]
> > > 
> > >> +/**
> > >> + * enum net_device_priv_flags - &struct net_device priv_flags
> > >> + *
> > >> + * These are the &struct net_device, they are only set internally
> > >> + * by drivers and used in the kernel but are invisible to userspace.
> > > 
> > > [...]
> > > 
> > > Indeed, I wonder why they are in the UAPI header.  As userland doesn't
> > > have a legitimate use for them, maybe you could move them back to
> > > include/linux/if.h instead of bothering with adding macros?
> > 
> > They are visible to userspace via sysfs.
> 
> In /sys/class/net/*/flags, although we are lacking quite a lot of documentation 
> for the exported attributes there.
> 
> The only attributes for which there is some sort of documentation are 
> "operstate" and the XPS/RFS/RPS attributes, maybe that could be fixed too as 
> part of this documentation patch?

Sure, but how about we take it one step at a time? I wanted to do this first
so I can extend the documentation of some flags private flags I'm reviewing
right now, so figured we'd start with the basic, non contravertial simple
documentation and then we can start piling up new shiny documentation.

  Luis