[PATCH] kernel-doc: improve "no structured comments found" error

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Johannes Berg <johannes.berg@xxxxxxxxx>

This error (typically) happens when using -function, in which
case it's useful to know what the script was looking for that
it couldn't find. Print out the functions.

Signed-off-by: Johannes Berg <johannes.berg@xxxxxxxxx>
---
 scripts/kernel-doc | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 4305b2f..e34daa5 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2536,6 +2536,9 @@ sub process_file($) {
     }
     if ($initial_section_counter == $section_counter) {
 	print STDERR "Warning(${file}): no structured comments found\n";
+	if ($function_only == 1) {
+	    print STDERR "    Was looking for '$_'.\n" for keys %function_table;
+        }
 	if ($output_mode eq "xml") {
 	    # The template wants at least one RefEntry here; make one.
 	    print "<refentry>\n";
-- 
1.8.0

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux