summaryrefslogtreecommitdiff
path: root/scripts/checkhelp.awk
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/checkhelp.awk')
-rwxr-xr-xscripts/checkhelp.awk37
1 files changed, 37 insertions, 0 deletions
diff --git a/scripts/checkhelp.awk b/scripts/checkhelp.awk
new file mode 100755
index 0000000..1a7e0ea
--- /dev/null
+++ b/scripts/checkhelp.awk
@@ -0,0 +1,37 @@
+#!/usr/bin/awk -f
+# AWK script to check for missing help entries for config options
+#
+# Copyright (C) 2006 Bernhard Fischer
+#
+# This file is distributed under the terms and conditions of the
+# MIT/X public licenses. See http://opensource.org/licenses/mit-license.html
+# and notice http://www.gnu.org/licenses/license-list.html#X11License
+
+
+/^choice/ { is_choice = 1; }
+/^endchoice/ { is_choice = 0; }
+/^config/ {
+ pos++;
+ conf[pos] = $2;
+ file[pos] = FILENAME;
+ if (is_choice) {
+ help[pos] = 1; # do not warn about 'choice' config entries.
+ } else {
+ help[pos] = 0;
+ }
+}
+/^[[:space:]]*help[[:space:]]*$/ {
+ help[pos] = 1;
+}
+BEGIN {
+ pos = -1;
+ is_choice = 0;
+}
+END {
+ for (i = 0; i < pos; i++) {
+# printf("%s: help for #%i '%s' == %i\n", file[i], i, conf[i], help[i]);
+ if (help[i] == 0) {
+ printf("%s: No helptext for '%s'\n", file[i], conf[i]);
+ }
+ }
+}