summaryrefslogtreecommitdiffstats
path: root/src/vlib
diff options
context:
space:
mode:
authorPaul Vinciguerra <pvinci@vinciconsulting.com>2019-04-11 06:32:19 -0700
committerDave Wallace <dwallacelf@gmail.com>2019-04-12 21:28:16 +0000
commitd54815c441c77f0b50d375848aef7fc4ff639492 (patch)
tree79bf3695423ba6b5d5ae7584e4ad37c575a1defe /src/vlib
parentbbf923fb52e8a9062ef4d740288cf5547c4dbde4 (diff)
Trivial: Update doxygen comments.
Change-Id: I2f7f3898b913c9b1a37b1c8c84a8df3799c49c5d Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
Diffstat (limited to 'src/vlib')
-rwxr-xr-xsrc/vlib/unix/main.c13
1 files changed, 10 insertions, 3 deletions
diff --git a/src/vlib/unix/main.c b/src/vlib/unix/main.c
index fe1f94d52f3..24ae416dbf4 100755
--- a/src/vlib/unix/main.c
+++ b/src/vlib/unix/main.c
@@ -564,10 +564,11 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
*
* @cfgcmd{runtime-dir}
* Define directory where VPP is going to store all runtime files.
- * Default is /run/vpp.
+ * Default is /run/vpp when running as root, /run/user/<UID>/vpp if running as
+ * an unprivileged user.
*
* @cfgcmd{cli-listen, &lt;address:port&gt;}
- * Bind the CLI to listen at the address and port given. @clocalhost
+ * Bind the CLI to listen at the address and port given. @c localhost
* on TCP port @c 5002, given as <tt>cli-listen localhost:5002</tt>,
* is typical.
*
@@ -579,7 +580,7 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
* Configure the CLI prompt to be @c string.
*
* @cfgcmd{cli-history-limit, &lt;nn&gt;}
- * Limit commmand history to @c nn lines. A value of @c 0
+ * Limit command history to @c nn lines. A value of @c 0
* disables command history. Default value: @c 50
*
* @cfgcmd{cli-no-banner}
@@ -591,6 +592,12 @@ unix_config (vlib_main_t * vm, unformat_input_t * input)
* @cfgcmd{cli-pager-buffer-limit, &lt;nn&gt;}
* Limit pager buffer to @c nn lines of output.
* A value of @c 0 disables the pager. Default value: @c 100000
+ *
+ * @cfgcmd{gid, &lt;nn&gt;}
+ * Set the effective gid under which the vpp process is to run.
+ *
+ * @cfgcmd{poll-sleep-usec, &lt;nn&gt;}
+ * Set a fixed poll sleep interval between main loop polls.
?*/
VLIB_EARLY_CONFIG_FUNCTION (unix_config, "unix");