Temporary fix for CLI doc macro expansion; VPP-417

One CLI initializer has been modified temporarily to
avoid macro expansion that the siphon CLI documentation parser
doesn't understand.

Removed macros: ila_type_list, ila_csum_list and ila_direction_list.

Also make docs use the official version without the offset-from-tag
count we would other wise get in this stable release.

Change-Id: I52e1fa215f540583f0610200ec28349e67f56a32
Signed-off-by: Chris Luke <chrisy@flirble.org>

diff --git a/doxygen/Makefile b/doxygen/Makefile
index 41befe4..0a27dca 100644 (file)
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -152,7 +152,7 @@ doxygen: $(SIPHON_DOCS)
            INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT)) $(EXTRA_DOXY_INPUT)" \
            INCLUDE_PATH="$(DOXY_INCLUDE_PATH)" \
            HTML=YES \
-           VERSION="`git describe --tags --dirty`" \
+           VERSION="v`./build-root/scripts/version rpm-version`" \
            doxygen $(DOXY_DIR)/doxygen.cfg
 
 wipe-doxygen:

diff --git a/plugins/ila-plugin/ila/ila.c b/plugins/ila-plugin/ila/ila.c
index b834880..8759fc7 100644 (file)
--- a/plugins/ila-plugin/ila/ila.c
+++ b/plugins/ila-plugin/ila/ila.c
@@ -947,14 +947,23 @@ ila_entry_command_fn (vlib_main_t * vm,
   return NULL;
 }
 
+/* *INDENT-OFF* */
+/* Note VPP-417; this initializer has been modified temporarily to
+ * avoid macro expansion that the siphon CLI documentation parser
+ * doesn't understand.
+ * Removed macros: ila_type_list, ila_csum_list and ila_direction_list.
+ */
 VLIB_CLI_COMMAND (ila_entry_command, static) =
 {
-.path = "ila entry",.short_help = "ila entry [type (" ila_type_list ")]"
-    " [sir-address <address>] [locator <locator>] [vnid <hex-vnid>]"
-    " [adj-index <adj-index>] [next-hop <next-hop>]"
-    " [direction (" ila_direction_list ")]"
-    " [csum-mode (" ila_csum_list ")] [del]",.function =
-    ila_entry_command_fn,};
+    .path = "ila entry",
+    .short_help = "ila entry [type (" "iid,luid,vnid-ip4,vnid-ip6,vnid-multicast" ")]"
+       " [sir-address <address>] [locator <locator>] [vnid <hex-vnid>]"
+       " [adj-index <adj-index>] [next-hop <next-hop>]"
+       " [direction (" "bidir,sir2ila,ila2sir" ")]"
+       " [csum-mode (" "no-action,neutral-map,adjust-transport" ")] [del]",
+    .function = ila_entry_command_fn,
+};
+/* *INDENT-ON* */
 
 static clib_error_t *
 ila_interface_command_fn (vlib_main_t * vm,