]> err.no Git - linux-2.6/commit
[PATCH] kernel-doc: warn on malformed function docs.
authorRandy Dunlap <rdunlap@xenotime.net>
Sun, 25 Jun 2006 12:48:55 +0000 (05:48 -0700)
committerLinus Torvalds <torvalds@g5.osdl.org>
Sun, 25 Jun 2006 17:01:20 +0000 (10:01 -0700)
commit850622dfaf3d62907c96707773e0f8e84b3c0c06
tree905e002ee082453ab8da9f4a8fe805d69f59bc45
parent9c8ef5614da22666e339b125263d315cfaa89109
[PATCH] kernel-doc: warn on malformed function docs.

When the verbose (-v) option is used with scripts/kernel-doc, this option
reports when the kernel-doc format is malformed and apparently contains
function description lines before function parameters.  In these cases, the
kernel-doc script will print something like: Warning(filemap.c:335):
contents before sections

I have fixed the problems in mm/filemap.c and added lots of kernel-doc to
that file (posted to the linux-mm mailing list Mon.  2006-June-12).

The real goal (as requested by Andrew Morton) is to allow the short
function description to be more than one line long.  This patch is both a
kernel-doc checker and a tool en route to that goal.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
scripts/kernel-doc