kconfig: Warn if help text is blank
authorUlf Magnusson <ulfalizer@gmail.com>
Wed, 31 Jan 2018 09:34:30 +0000 (10:34 +0100)
committerMasahiro Yamada <yamada.masahiro@socionext.com>
Fri, 2 Feb 2018 15:02:19 +0000 (00:02 +0900)
Blank help texts are probably either a typo, a Kconfig misunderstanding,
or some kind of half-committing to adding a help text (in which case a
TODO comment would be clearer, if the help text really can't be added
right away).

Best to flag them, IMO.

Example warning:

drivers/mmc/host/Kconfig:877: warning: 'MMC_TOSHIBA_PCI' defined with blank help text

Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
scripts/kconfig/zconf.y

index 21ce883e5d9ed73f5da535fcfc39dc6515916b6b..4be98050b961fe73df6bf6516b1e5a7f8135d149 100644 (file)
@@ -436,6 +436,12 @@ help: help_start T_HELPTEXT
                zconfprint("warning: '%s' defined with more than one help text -- only the last one will be used",
                           current_entry->sym->name ?: "<choice>");
        }
+
+       /* Is the help text empty or all whitespace? */
+       if ($2[strspn($2, " \f\n\r\t\v")] == '\0')
+               zconfprint("warning: '%s' defined with blank help text",
+                          current_entry->sym->name ?: "<choice>");
+
        current_entry->help = $2;
 };