summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-07-12 18:03:05 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2010-11-01 16:23:08 +0100
commit511c5d8d0c0b1dcd0fd435fa1a2f58ba58df2af2 (patch)
tree210e929be8178aa4116fe2972d96f4d6e1e95ecc /scripts
parentc84a37d52b8a40bf1fb62d1a9827f2fe59c15fa9 (diff)
downloadbarebox-511c5d8d0c0b1dcd0fd435fa1a2f58ba58df2af2.tar.gz
barebox-511c5d8d0c0b1dcd0fd435fa1a2f58ba58df2af2.tar.xz
doc: add macros to unify command help with doxygen
Currently we have duplicated all the information that appears online in 'help <command>' and in the doxygen documentation. This patch adds some infrastructure to specify help texts only once and re-use them for the integrated help as well as for the manual. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Diffstat (limited to 'scripts')
-rw-r--r--scripts/doxy_filter.awk103
1 files changed, 103 insertions, 0 deletions
diff --git a/scripts/doxy_filter.awk b/scripts/doxy_filter.awk
new file mode 100644
index 0000000000..5ec0406298
--- /dev/null
+++ b/scripts/doxy_filter.awk
@@ -0,0 +1,103 @@
+#!/usr/bin/awk
+
+/BAREBOX_CMD_HELP_START[[:space:]]*\((.*)\)/ {
+
+ this_opt = 0;
+ my_usage = "";
+ my_short = "";
+ my_cmd = gensub("BAREBOX_CMD_HELP_START[[:space:]]*\\((.*)\\)", "\\1", "g");
+ this_text = 0;
+ delete(my_text);
+ delete(my_opts);
+ next;
+}
+
+/BAREBOX_CMD_HELP_USAGE[[:space:]]*\((.*)\)/ {
+
+ $0 = gensub("<", "\\&lt;", "g");
+ $0 = gensub(">", "\\&gt;", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_USAGE[[:space:]]*\\((.*)\\)", "\\1", "g");
+ $0 = gensub("\\\\n", "", "g");
+ my_usage = gensub("\"", "", "g");
+ next;
+
+}
+
+/BAREBOX_CMD_HELP_SHORT[[:space:]]*\((.*)\)/ {
+
+ $0 = gensub("<", "\\&lt;", "g");
+ $0 = gensub(">", "\\&gt;", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_SHORT[[:space:]]*\\((.*)\\)", "\\1", "g");
+ $0 = gensub("\\\\n", "", "g");
+ my_short = gensub("\"", "", "g");
+ next;
+
+}
+
+/BAREBOX_CMD_HELP_OPT[[:space:]]*\([[:space:]]*(.*)[[:space:]]*,[[:space:]]*(.*)[[:space:]]*\)/ {
+
+ $0 = gensub("<", "\\&lt;", "g");
+ $0 = gensub(">", "\\&gt;", "g");
+ $0 = gensub("@", "\\\\@", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_OPT[[:space:]]*\\([[:space:]]*\"*(.*)\"[[:space:]]*,[[:space:]]*\"(.*)\"[[:space:]]*\\)", \
+ "<tr><td><tt> \\1 </tt></td><td>\\&nbsp;\\&nbsp;\\&nbsp;</td><td> \\2 </td></tr>", "g");
+ $0 = gensub("\\\\n", "", "g");
+ my_opts[this_opt] = gensub("\"", "", "g");
+ this_opt ++;
+ next;
+}
+
+/BAREBOX_CMD_HELP_TEXT[[:space:]]*\((.*)\)/ {
+
+ $0 = gensub("<", "\\&lt;", "g");
+ $0 = gensub(">", "\\&gt;", "g");
+ $0 = gensub("BAREBOX_CMD_HELP_TEXT[[:space:]]*\\((.*)\\)", "\\1", "g");
+ $0 = gensub("\\\\n", "<br>", "g");
+ my_text[this_text] = gensub("\"", "", "g");
+ this_text ++;
+ next;
+}
+
+/BAREBOX_CMD_HELP_END/ {
+
+ printf "/**\n";
+ printf " * @page " my_cmd "_command " my_cmd "\n";
+ printf " *\n";
+ printf " * \\par Usage:\n";
+ printf " * " my_usage "\n";
+ printf " *\n";
+
+ if (this_opt != 0) {
+ printf " * \\par Options:\n";
+ printf " *\n";
+ printf " * <table border=\"0\" cellpadding=\"0\">\n";
+ n = asorti(my_opts, my_opts_sorted);
+ for (i=1; i<=n; i++) {
+ printf " * " my_opts[my_opts_sorted[i]] "\n";
+ }
+ printf " * </table>\n";
+ printf " *\n";
+ }
+
+ printf " * " my_short "\n";
+ printf " *\n";
+
+ n = asorti(my_text, my_text_sorted);
+ if (n > 0) {
+ for (i=1; i<=n; i++) {
+ printf " * " my_text[my_text_sorted[i]] "\n";
+ }
+ printf " *\n";
+ }
+
+ printf " */\n";
+
+ next;
+}
+
+/^.*$/ {
+
+ print $0;
+
+}
+