public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Fengguang Wu <fengguang.wu@intel.com>
To: Mark Brown <broonie@kernel.org>
Cc: Randy Dunlap <rdunlap@infradead.org>,
	LKML <linux-kernel@vger.kernel.org>,
	Linus Torvalds <torvalds@linux-foundation.org>,
	Liam Girdwood <lgirdwood@gmail.com>
Subject: Re: [PATCH] regulator: fix fatal kernel-doc error
Date: Wed, 18 Sep 2013 07:33:28 +0800	[thread overview]
Message-ID: <20130917233328.GC11390@localhost> (raw)
In-Reply-To: <20130917192355.GK21013@sirena.org.uk>

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

  reply	other threads:[~2013-09-17 23:33 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-09-17  1:08 [PATCH] regulator: fix fatal kernel-doc error Randy Dunlap
2013-09-17 10:32 ` Mark Brown
2013-09-17 17:09   ` Randy Dunlap
2013-09-17 19:23     ` Mark Brown
2013-09-17 23:33       ` Fengguang Wu [this message]
2013-09-19 14:01         ` Mark Brown
2013-09-19 15:26           ` Fengguang Wu
2013-09-19 15:52             ` Mark Brown

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20130917233328.GC11390@localhost \
    --to=fengguang.wu@intel.com \
    --cc=broonie@kernel.org \
    --cc=lgirdwood@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=torvalds@linux-foundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox