summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/etc/requirements.txt47
-rw-r--r--docs/gettingstarted/developers/add_plugin.rst23
-rw-r--r--docs/gettingstarted/developers/index.rst2
-rw-r--r--docs/reference/cmdreference/index.rst7
4 files changed, 32 insertions, 47 deletions
diff --git a/docs/etc/requirements.txt b/docs/etc/requirements.txt
index 59b5b8caa31..c830f977ba8 100644
--- a/docs/etc/requirements.txt
+++ b/docs/etc/requirements.txt
@@ -1,44 +1,23 @@
-alabaster==0.7.10
-argh==0.26.2
-Babel==2.5.3
-backports-abc==0.5
-certifi==2018.1.18
+alabaster==0.7.12
+Babel==2.6.0
+certifi==2018.10.15
chardet==3.0.4
CommonMark==0.5.4
-doc8==0.8.0
docutils==0.14
-futures==3.2.0; python_version < '3.0'
-idna==2.6
-imagesize==1.0.0
+idna==2.7
+imagesize==1.1.0
Jinja2==2.10
-livereload==2.5.1
MarkupSafe==1.0
-packaging==17.1
-pathtools==0.1.2
-pbr==4.0.2
-pluggy==0.6.0
-port-for==0.3.1
-py==1.5.3
+packaging==18.0
Pygments==2.2.0
-pyparsing==2.2.0
-pytz==2018.4
-PyYAML==3.12
+pyparsing==2.3.0
+pytz==2018.7
recommonmark==0.4.0
requests==2.20.0
-restructuredtext-lint==1.1.3
-singledispatch==3.4.0.3
six==1.11.0
snowballstemmer==1.2.1
-Sphinx==1.7.2
-sphinx-autobuild==0.7.1
-sphinx-bootstrap-theme==0.6.5
-sphinx-rtd-theme==0.3.0
-sphinxcontrib-httpdomain==1.6.1
-sphinxcontrib-websupport==1.0.1
-stevedore==1.28.0
-tornado==5.0.2
-tox==3.0.0
-typing==3.6.4
-urllib3==1.22
-virtualenv==15.2.0
-watchdog==0.8.3
+Sphinx==1.8.1
+sphinx-rtd-theme==0.4.2
+sphinxcontrib-websupport==1.1.0
+typing==3.6.6
+urllib3==1.24
diff --git a/docs/gettingstarted/developers/add_plugin.rst b/docs/gettingstarted/developers/add_plugin.rst
index eb9113a2efc..16952e8f036 100644
--- a/docs/gettingstarted/developers/add_plugin.rst
+++ b/docs/gettingstarted/developers/add_plugin.rst
@@ -9,20 +9,20 @@ Overview
________
This section shows how a VPP developer can create a new plugin, and
-add it to VPP.
+add it to VPP. We assume that we are starting from the VPP <top-of-workspace>.
As an example, we will use the **make-plugin.sh** tool found in
-**.../extras/emacs**. make-plugin.sh is a simple wrapper for a comprehensive
+**./extras/emacs**. make-plugin.sh is a simple wrapper for a comprehensive
plugin generator constructed from a set of emacs-lisp skeletons.
Create your new plugin
----------------------
-Change directory to **.../src/plugins**, and run the plugin generator:
+Change directory to **./src/plugins**, and run the plugin generator:
.. code-block:: console
- $ cd .../src/plugins
+ $ cd ./src/plugins
$ ../../extras/emacs/make-plugin.sh
<snip>
Loading /scratch/vpp-docs/extras/emacs/tunnel-c-skel.el (source)...
@@ -63,7 +63,7 @@ Here are the generated files. We'll go through them in a moment.
.. code-block:: console
- $ cd .../src/plugins/myplugin
+ $ cd ./myplugin
$ ls
CMakeLists.txt myplugin.c myplugin_periodic.c setup.pg
myplugin_all_api_h.h myplugin.h myplugin_test.c
@@ -191,11 +191,16 @@ instance of this data structure.
You can enable or disable specific vpp plugins from the command
line. By default, plugins are loaded. To change that behavior, set
-default_disabled in the vlib_plugin_macro:
+default_disabled in the macro VLIB_PLUGIN_REGISTER:
.. code-block:: console
- .default_disabled = 1
+ VLIB_PLUGIN_REGISTER () =
+ {
+ .version = VPP_BUILD_VER,
+ .default_disabled = 1
+ .description = "myplugin plugin description goes here",
+ };
The boilerplate generator places the graph node dispatch function
onto the "device-input" feature arc. This may or may not be useful.
@@ -273,3 +278,7 @@ vlib_plugin_get_symbol(...) API:
void *p = vlib_get_plugin_symbol ("plugin_name", "symbol");
+More Examples
+-------------
+
+For more information you can read many example plugins in the directory "./src/plugins".
diff --git a/docs/gettingstarted/developers/index.rst b/docs/gettingstarted/developers/index.rst
index 3520ed377f5..525f1b72305 100644
--- a/docs/gettingstarted/developers/index.rst
+++ b/docs/gettingstarted/developers/index.rst
@@ -21,6 +21,7 @@ The Developers section covers the following areas:
building
running_vpp
gdb_examples
+ add_plugin
gitreview
softwarearchitecture
infrastructure
@@ -34,5 +35,4 @@ The Developers section covers the following areas:
binary_api_support
buildsystem/index.rst
eventviewer
- add_plugin
fib20/index.rst
diff --git a/docs/reference/cmdreference/index.rst b/docs/reference/cmdreference/index.rst
index 802dc8bd948..c51dd367ae0 100644
--- a/docs/reference/cmdreference/index.rst
+++ b/docs/reference/cmdreference/index.rst
@@ -13,6 +13,7 @@ The debug CLI can be executed from a su (superuser) shell using the vppctl comma
# sudo bash
# vppctl show interface
+
Name Idx State Counter Count
TenGigabitEthernet86/0/0 1 up rx packets 6569213
rx bytes 9928352943
@@ -32,10 +33,6 @@ Commands can also be executed from the vppct shell.
# vppctl
- __/ __/ _ \ (_)__ | | / / _ \/ _ \
- _/ _// // / / / _ \ | |/ / ___/ ___/
- /_/ /____(_)_/\___/ |___/_/ /_/
-
vpp# show interface
Name Idx State Counter Count
TenGigabitEthernet86/0/0 1 up rx packets 6569213
@@ -57,4 +54,4 @@ Commands can also be executed from the vppct shell.
ip/index.rst
show/index.rst
trace/index.rst
- vhost/index.rst \ No newline at end of file
+ vhost/index.rst