From 49fe046e431c4d76b0c45c609e05e1b0a3063360 Mon Sep 17 00:00:00 2001
From: Dave Barach <dave@barachs.net>
Date: Tue, 12 Sep 2017 17:06:56 -0400
Subject: API message table inspection utilities

Add doxygen tags for show/clear commands

Change-Id: Ic939c561b15b0b720a8db1ecacc17e3d74419e1d
Signed-off-by: Dave Barach <dave@barachs.net>
---
 src/vpp/conf/startup.conf | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/vpp/conf/startup.conf')

diff --git a/src/vpp/conf/startup.conf b/src/vpp/conf/startup.conf
index 6ebe1efe9ee..c3b9872ec9a 100644
--- a/src/vpp/conf/startup.conf
+++ b/src/vpp/conf/startup.conf
@@ -8,7 +8,20 @@ unix {
 }
 
 api-trace {
+## This stanza controls binary API tracing. Unless there is a very strong reason,
+## please leave this feature enabled.
   on
+## Additional parameters:
+##
+## To set the number of binary API trace records in the circular buffer, configure nitems
+##
+## nitems <nnn> 
+##
+## To save the api message table decode tables, configure a filename. Results in /tmp/<filename>
+## Very handy for understanding api message changes between versions, identifying missing
+## plugins, and so forth.
+##
+## save-api-table <filename>
 }
 
 api-segment {
-- 
cgit 1.2.3-korg