Re: [PATCH] regulator: fix fatal kernel-doc error

From: Fengguang Wu
Date: Tue Sep 17 2013 - 19:34:05 EST


On Tue, Sep 17, 2013 at 08:23:55PM +0100, Mark Brown wrote:
> On Tue, Sep 17, 2013 at 10:09:24AM -0700, Randy Dunlap wrote:
> > On 09/17/13 03:32, Mark Brown wrote:

> > /** means kernel-doc syntax and it was not in proper kernel-doc format,
> > but maybe it could just be a Warning instead of a fatal Error.
>
> Yes, that's what I'm saying - it really doesn't seem like something that
> should be a fatal error, that's far too fragile.
>
> > Ideally we should pick it up in -next, of course, but I doubt that anyone
> > is running kernel-doc on linux-next. I used to do that, but there are
> > too many errors/warnings. I suppose that I could just concentrate on
> > (fatal) Errors in linux-next and ignore the Warnings.
>
> Could these checks be added to Fengguang's tester? If nobody's looking
> at the output (I've never found the processed output useful myself) or
> running the tool then it's a bit worrying...

Yes, I'm running "make htmldocs" checks and send out all new warnings:

Sep 03 To Mark Brown ( 19:0) [regulator:topic/devm 5/15] Warning(drivers/regulator/core.c:3750): No description found for parameter 'dev'
Sep 06 To Miklos Szere ( 20:0) [vfs:for-miklos 34/43] Warning(fs/dcache.c:1167): No description found for parameter 'data'
Sep 10 To Waiman Long ( 22:0) [vfs:for-next 9/10] Warning(fs/dcache.c:102): No description found for parameter 'lock'
Sep 11 To Lars-Peter C ( 25:0) [xlnx:master-next 96/99] Warning(drivers/gpu/drm/drm_edid.c:1061): No description found for parameter 'data'
Sep 12 To Brian Norris ( 13:0) [l2-mtd:master 9/11] Warning(include/linux/mtd/nand.h:587): Excess struct/union/enum/typedef member 'ecclayout'

Does that sound enough?

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