aboutsummaryrefslogtreecommitdiffstats
path: root/src/vnet/dir.dox
diff options
context:
space:
mode:
authorBilly McFall <bmcfall@redhat.com>2017-08-11 14:05:11 -0400
committerDave Barach <openvpp@barachs.net>2017-08-15 12:34:51 +0000
commite9bac6953d03440f2f7437f4e3f0a4e3bf7f8a60 (patch)
tree73ed9febcc12385ebb03ab51b1d96180ce2891be /src/vnet/dir.dox
parentab0289a85c45699878d203b4a0d2e5b38c36cc55 (diff)
VPP-939: Update CLI Helptext for rx-placement commands
The CLI commands were change from 'set/show interface placement' to 'set/show interface rx-placement', but the associated help text was not updated. On the 'set interface rx-placement', some of the parameters were renamed, which was confusing when looking at the documentation for help. While in the file interface_cli.c, cleaned up several other CLI commands. There are still other commands in the file that need addressing. Change-Id: Ifdc357c73ad9f3362133c495217b5a6b3a411eab Signed-off-by: Billy McFall <bmcfall@redhat.com>
Diffstat (limited to 'src/vnet/dir.dox')
-rw-r--r--src/vnet/dir.dox29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/vnet/dir.dox b/src/vnet/dir.dox
new file mode 100644
index 00000000000..8bc2c4cf1b2
--- /dev/null
+++ b/src/vnet/dir.dox
@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2017 Red Hat and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/* Doxygen directory documentation */
+
+/**
+@dir
+@brief Interface.
+
+This is a high level directory which contains sub-directories for all the
+networking protocols. Also contained within this directory are more generic
+CLI command files such as interface management.
+
+*/
+/*? %%clicmd:group_label Interface %% ?*/
+/*? %%syscfg:group_label Interface %% ?*/