Re: [B.A.T.M.A.N.] [PATCH 1/7] batman-adv: remove useless inline attribute for sysfs helper function

Sven Eckelmann
2016-05-06T07:23:40Z

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

On Friday 06 May 2016 10:34:34 Antonio Quartulli wrote:
> On Thu, May 05, 2016 at 10:17:18PM +0200, Sven Eckelmann wrote:
> > On Friday 06 May 2016 02:46:37 Antonio Quartulli wrote:
> > > the compiler can optimize functions within the same C file and therefore
> > > there is no need to make it explicit.
> > >
> > > Remove the useless inline attribute for __batadv_store_uint_attr()
> > >
> > > Signed-off-by: Antonio Quartulli <a@unstable.cc>
> > > ---
> > >
> > > net/batman-adv/sysfs.c | 12 ++++++------
> > > 1 file changed, 6 insertions(+), 6 deletions(-)
> >
> > This is not about this particular patch but for the patch series.
> >
> > Please check the attached test results of the daily build tests.
>
> Sven,
>
>
> do you know how I can deal with:
>
> ./net/batman-adv/types.h:1338: warning: No description found for parameter
> 'gw'
>
> ?
>
> There are also other objects similar to that in the bat_algo_ops (i.e.
> iface, neigh, ..), but the check complains about gw only ?

Kerneldoc cannot parse these kind of substructures. Just run:

scripts/kernel-doc -html net/batman-adv/types.h > test.html
chromium test.html

It just creates random noise from your kerneldoc input. So one way to deal
with it is to create a substruct hacks parse functionality for kerneldoc or
avoid these kind of anonymous-type substructs and use extra correctly typed
structs.

You can contact Jonathan Corbet and inform him that these kinds of things are
not "correctly" parsed (and don't use dirty hacks to creat kerneldoc-sections
like struct sockaddr_caif used for its union kerneldoc). Maybe with a small
example.

Kind regards,
Sven

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