Re: [PATCH] kernel-doc: fix plist.h comments

[Oleg Nesterov <oleg@tv-sign.ru>]

On 04/11, Randy Dunlap wrote:
>
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Make kernel-doc comments match macro names.
> Correct parameter names in a few places.
> Remove '#' from beginning of kernel-doc comment macro names.
> Remove extra (erroneous) blank lines in kernel-doc.
> 
> Warning(plist.h:100): Cannot understand  * #PLIST_HEAD_INIT - static struct plist_head initializer on line 100 - I thought it was a doc line
> Warning(plist.h:112): Cannot understand  * #PLIST_NODE_INIT - static struct plist_node initializer on line 112 - I thought it was a doc line
> Warning(plist.h:103): No description found for parameter '_lock'
> Warning(plist.h:129): No description found for parameter 'lock'
> Warning(plist.h:158): No description found for parameter 'pos'
> Warning(plist.h:169): No description found for parameter 'pos'
> Warning(plist.h:169): No description found for parameter 'n'
> Warning(plist.h:179): No description found for parameter 'mem'
> 
> This still leaves one warning & one error that need attention:
> Error(plist.h:219): cannot understand prototype: '('
> Warning(plist.h): no structured comments found

(off-topic)

plist is very simple and generic. It's a pity we have plist_head.lock.
It is strange that plist_del() has a "head" parameter just to make
CONFIG_DEBUG_PI_LIST happy.

It would be better imho to make a separate d_plist_head or something for
rtmutex.

Oleg.

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/