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

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20130917233328.GC11390@localhost>
Date:	Wed, 18 Sep 2013 07:33:28 +0800
From:	Fengguang Wu <fengguang.wu@...el.com>
To:	Mark Brown <broonie@...nel.org>
Cc:	Randy Dunlap <rdunlap@...radead.org>,
	LKML <linux-kernel@...r.kernel.org>,
	Linus Torvalds <torvalds@...ux-foundation.org>,
	Liam Girdwood <lgirdwood@...il.com>
Subject: Re: [PATCH] regulator: fix fatal kernel-doc error

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@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/