iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

kernel-doc: warn on badly formatted short description

Browse Source 
Make kernel-doc warn when a function/struct/union/typedef does not contain
a properly formatted short description, such as:
 * scsi_devinfo: set up the dynamic device list
or
 * scsi_devinfo -

This warning is only generated when verbose (-v) mode is used.

Also explain the -v command line option in the -h output.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Randy Dunlap 2008-02-07 00:13:42 -08:00 committed by Linus Torvalds
parent 792aa2f2cc
commit 77cc23b8c7
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
scripts/kernel-doc
View File

@ -218,6 +218,7 @@ sub usage {
print " [ -function funcname [ -function funcname ...] ]\n"; print " [ -function funcname [ -function funcname ...] ]\n";
print " [ -nofunction funcname [ -nofunction funcname ...] ]\n"; print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
print " c source file(s) > outputfile\n"; print " c source file(s) > outputfile\n";
print " -v : verbose output, more warnings & other info listed\n";
exit 1; exit 1;
} }
@ -1881,6 +1882,13 @@ sub process_file($) {
} else { } else {
$declaration_purpose = ""; $declaration_purpose = "";
} }
if (($declaration_purpose eq "") && $verbose) {
print STDERR "Warning(${file}:$.): missing initial short description on line:\n";
print STDERR $_;
++$warnings;
}
if ($identifier =~ m/^struct/) { if ($identifier =~ m/^struct/) {
$decl_type = 'struct'; $decl_type = 'struct';
} elsif ($identifier =~ m/^union/) { } elsif ($identifier =~ m/^union/) {