The patch titled
kernel-doc: warn on malformed function docs.
has been added to the -mm tree. Its filename is
kernel-doc-warn-on-malformed-function-docs.patch
See http://www.zip.com.au/~akpm/linux/patches/stuff/added-to-mm.txt to find
out what to do about this
------------------------------------------------------
Subject: kernel-doc: warn on malformed function docs.
From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
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@xxxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxx>
---
scripts/kernel-doc | 7 +++++++
1 file changed, 7 insertions(+)
diff -puN scripts/kernel-doc~kernel-doc-warn-on-malformed-function-docs scripts/kernel-doc
--- a/scripts/kernel-doc~kernel-doc-warn-on-malformed-function-docs
+++ a/scripts/kernel-doc
@@ -253,6 +253,7 @@ my $lineprefix="";
# 3 - scanning prototype.
# 4 - documentation block
my $state;
+my $in_doc_sect;
#declaration types: can be
# 'function', 'struct', 'union', 'enum', 'typedef'
@@ -1706,6 +1707,7 @@ sub process_file($) {
if ($state == 0) {
if (/$doc_start/o) {
$state = 1; # next line is always the function name
+ $in_doc_sect = 0;
}
} elsif ($state == 1) { # this line is the function name (always)
if (/$doc_block/o) {
@@ -1756,10 +1758,15 @@ sub process_file($) {
$newcontents = $2;
if ($contents ne "") {
+ if (!$in_doc_sect && $verbose) {
+ print STDERR "Warning(${file}:$.): contents before sections\n";
+ ++$warnings;
+ }
dump_section($section, xml_escape($contents));
$section = $section_default;
}
+ $in_doc_sect = 1;
$contents = $newcontents;
if ($contents ne "") {
if (substr($contents, 0, 1) eq " ") {
_
Patches currently in -mm which might be from rdunlap@xxxxxxxxxxxx are
git-alsa.patch
git-dvb.patch
git-infiniband.patch
git-kbuild.patch
git-mtd.patch
git-netdev-all.patch
git-pcmcia.patch
lpfc-sparse-null-warnings.patch
aic7-cleanup-module_parm_desc-strings.patch
qla1280-fix-section-mismatch-warnings.patch
areca-raid-linux-scsi-driver.patch
git-watchdog.patch
slab-kmalloc-kzalloc-comments-cleanup-and-fix.patch
kernel-doc-for-mm-filemapc.patch
add-poisonh-and-patch-primary-users.patch
update-2-drivers-for-poisonh.patch
poison-add-use-more-constants.patch
add-doc-submitchecklist.patch
doc-add-audit-acct-to-docbook.patch
codingstyle-add-typedefs-chapter.patch
fix-listh-kernel-doc.patch
listh-doc-change-counter-to-control.patch
kernel-doc-drop-leading-space-in-sections.patch
kernel-doc-script-cleanups.patch
wd7000-fix-section-mismatch-warnings.patch
megaraid_mbox-fix-section-mismatch-warnings.patch
kernel-doc-mm-readhead-fixup.patch
checkstack-pirnt-module-names.patch
wan-sdla-section-fixes.patch
trident-fb-section-fixes.patch
cdrom-mcdx-section-fixes.patch
char-ip2-more-section-fixes-replacement.patch
advansys-section-fixes.patch
kernel-doc-warn-on-malformed-function-docs.patch
pi-futex-rt-mutex-docs-update.patch
acpi-identify-which-device-is-not-power-manageable.patch
-
To unsubscribe from this list: send the line "unsubscribe mm-commits" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
