143 Commits

Author SHA1 Message Date
Dave Barach
4f88004bc3 docs: vpp stateless traffic generator
Add a use-case writeup.

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Ib6e79e80455edbdeedcc96943dd98f16c57c559e
(cherry picked from commit b8f6122b4f4c828dee103d1f3116d27e6e3e6f3a)
2021-01-22 14:02:48 +00:00
Paul Vinciguerra
d1598d4274 docs: update list of plugins
The list of plugins is outdated.

This change introduces a dynamically
generated list of the plugins along with their descriptions,
extracted directly from the sources.

Type: docs

Change-Id: Icb7b65e6b45289e257d71a1c18d10f62ced59cbe
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
(cherry picked from commit 630ca994e0ff210a3de80d73bb395c931d2fd83f)
2020-12-21 23:23:53 +00:00
Paul Vinciguerra
1e44cf53b5 docs: fix missing quotes in ubuntu install instructions
type: docs

Change-Id: Ifa09b63924f4b7bf2719bba6ada0e1122407641c
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
(cherry picked from commit ac9a585c6207ac876025f924aeb96ddcac8c8805)
2020-12-18 23:37:48 +00:00
Dave Wallace
d88c9a13e8 build: remove opensuse build infra
- VPP on opensuse has not been supported
  for several releases.

Type: fix

Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
Change-Id: I2b5316ad5c20a843b8936f4ceb473f932a5338d9
(cherry picked from commit bc35f469c89daf0126937580b6972516b5007d3a)
2020-09-22 11:35:12 +00:00
Nathan Skrzypczak
c4781a32df docs: Improve new plugin doc & add govpp API doc
Type: docs

Change-Id: I5f20ac0232c5cdc3cf64015185b0d0fc5c4a3100
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-09 20:44:08 +00:00
Nathan Skrzypczak
f681e9f736 docs: Update and improve indent install
Type: docs

Change-Id: I1a37450261e0bcedf90685243b14027f3cf23704
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-09 20:44:00 +00:00
Nathan Skrzypczak
24179ee1a4 docs: Improve & link cnat doc
Type: docs

Change-Id: Ib985ed6a644ae3f4c330bf6a27dc69c49a489a2f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-05 08:37:51 +00:00
Christian Hopps
047f67eedd docs: correct fib tunnel diagram reference
The included image was pulling in figure 2, change to the correct
figure 11.

Type: docs
Signed-off-by: Christian Hopps <chopps@labn.net>
Change-Id: I3679916364753fc682d1d1713fce952de398e626
2020-08-13 12:29:10 +00:00
John DeNisco
b046487622 docs: Update the VPP tutorial
Update the documents for the VPP tutorial.

Type: fix

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I62d0641ff0af7b07a26b4379f19cbdaf285537d7
2020-07-28 16:30:53 +00:00
John DeNisco
742000af20 docs: Reflect the fact that the DPDK is now a plugin
Type: Improvement

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic1253f601ee515392902a21b92e1dfd3962cc0a4
2020-07-06 12:30:31 -04:00
Dave Barach
b30b9549ac vlib: debug CLI macro expander, part deux
Deal with circular macro definitions instead of crashing due to stack
overflow.

Separate macro tables, per CLI session

Add documentation to the Sphinx docs

Type: improvement

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I55fc9152bd37ad0c15fa3959f38b07b63100e634
2020-06-23 15:35:14 +00:00
Damjan Marion
cea46522e7 vlib: address sanitizer support for stack switch, enable clang
Type: improvement
Change-Id: I81df4b61d1f0b8c1df77c1ee9bebcb491e155b69
Signed-off-by: Damjan Marion <damarion@cisco.com>
2020-06-16 16:05:01 +00:00
Dave Barach
ce412fd7d6 docs: improve handoff queue writeup
Type: docs
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I4d63a0fbbdb3cc00eac9116f122e5b831d059e33
2020-06-03 20:17:45 +00:00
John DeNisco
d52820d264 docs: Minor fixes in publish_docs.sh and sanitizer.rst
Fix a warning in sanitizer.rst and publish_docs.sh

Type: fix

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I66d724f52a7b724a97a894e1cd35c1239aeedcdf
2020-05-29 13:12:40 +00:00
Benoît Ganne
ca86c95a34 docs: asan: update doc to match current status
Type: docs

Change-Id: I45265876c9c778f6b91d39f30eb6035f14d166ec
Signed-off-by: Benoît Ganne <bganne@cisco.com>
2020-05-20 16:01:30 +00:00
Damjan Marion
5505ee8904 misc: deprecate elftool
Type: make

Change-Id: I34fec1c40ef660177c266517eaf41d60827609f4
Signed-off-by: Damjan Marion <damarion@cisco.com>
2020-05-07 16:47:33 +00:00
Dave Barach
aad5e0c16f vppinfra: add timer wheel section to Sphinx docs
Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Id0576d98b8e78cf4cd00161968d3eb6dbd58055a
2020-05-06 14:08:33 +00:00
Ruslan Babayev
e31820af10 vlib: add nosyslog unix option
The "nosyslog" option disables syslog just like the "interactive" mode
but can be used together with "nodaemon".

This is useful for when VPP is running under a process supervisor like
runit or daemontools that pipe the stdout/stderr to a dedicated logger
service.

Type: feature

Change-Id: Ic4287338d6836fea9f3eabdcf960dc1f51875dd1
Signed-off-by: Ruslan Babayev <ruslan@babayev.com>
2020-05-02 16:06:16 -07:00
Paul Vinciguerra
bfb377ce79 docs: add missing spelling dictionary
Type: docs

Change-Id: I334312f8bfe2000d4613908c2a0ba7e6a39d3825
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-04-28 17:43:44 +00:00
Benoît Ganne
332bc084dd misc: asan: disable leak sanitizer by default
Leak Sanitizer is not stable yet with VPP. It can always be enabled at
runtime with ASAN_OPTIONS=detect_leaks=1.

Type: fix

Change-Id: Ieff01091e2976e127783ebd331cd0e50a1dbca12
Signed-off-by: Benoît Ganne <bganne@cisco.com>
2020-04-22 13:04:00 +00:00
John DeNisco
98c2348b5c docs: Fix the Use Cases Index
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: If4d5ef8ab93c905493af074fb4c2096f1ab222d4
2020-04-09 14:23:35 -04:00
Paul Vinciguerra
a26f54421a docs: Fix venv under python3
See ticket for output under containers for each distro.

Ticket: VPP-1851
Type: docs

Change-Id: I0d80dabeb30d92d09edffa503b05d5eef08313dc
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-04-02 13:29:28 +00:00
Dave Barach
883bf3d1a3 docs: add a timebase precision section
Type: docs
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I47434cb305f291a6221780ff4ee9a2c1bb041286
2020-04-02 01:24:28 +00:00
Paul Vinciguerra
491741a404 docs ethernet: add docs for ethernet Section
Type: docs

Change-Id: I6ad92b35df3e0fecb1334511625eacf3e3d8925f
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-27 16:12:45 +00:00
Paul Vinciguerra
5ac392dc41 docs: minor typos in configuring/startup.rst
Change-Id: I8a6596d7cfa84cb2c5ee2d847395e9cea69c5349
Type: docs
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-27 16:11:41 +00:00
Dave Barach
64d9da3ba3 docs: document lxd container bootstrap procedure
Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I9cfa52637e813f2b990688b35634e3af10c58f6a
2020-03-27 12:21:26 +00:00
Dave Barach
ef633187e2 docs: add container functional test writeup
Fix global copyright date

Type: docs
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I7f010d63ec010982f2c8c8388f14214fa6ced0a7
2020-03-23 18:54:39 +00:00
John DeNisco
727c653f1c docs: Fix build on fresh ubuntu 18.04
Type: docs
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: If842c92183a9cf4b5a9773dced3298005b327e1a
2020-03-23 12:05:40 +00:00
John DeNisco
92a6ac24f3 docs: Add feature build to publish script
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I6a938f426b9a8e1242fa5c6f9716a3f9db4d4976
2020-03-11 16:14:30 +00:00
Dave Barach
437e33f1f9 docs: describe clib_time monotonic timebase support
Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I5b27d8b945472388498a4afc4be8dd868bb45ac3
2020-03-11 15:04:36 +00:00
Paul Vinciguerra
262971e783 docs: Add list of nodes for 'trace add'
(provided by Andrew/Damjan: git grep -h -B20 VLIB_NODE_FLAG_TRACE_SUPPORTED | grep VLIB_REGISTER_NODE | awk -F [\(\),] '{print $2 }' | sed 's/_/-/g' | sort |sed 's/-node//' )

Type: docs

Change-Id: I4a58fe5ed6bb3598551482ea1c5f16e502cbd6a7
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-09 11:35:05 +00:00
Paul Vinciguerra
5e0e0df9b4 docs: document the unformat '%_' option
Type: docs

Change-Id: Id864fcff768a78aa313b193f2eaabe545d95bec4
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-06 13:53:19 +00:00
Dave Barach
2fef3dfa5c vppinfra: deprecate CLIB_VEC64
Type: refactor
Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Id1e7c0926036db4601c91438397ceed22381fc07
2020-02-23 17:48:53 +00:00
Dave Barach
dee0a3bb04 http_static: VPP web application HowTo
This sketch should save a lot of time working out uninteresting but
important details.

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Icd5705230adfda6539360ef3c46ff3a68b3bed74
2020-02-11 17:10:07 +00:00
Dave Barach
78a1877463 vppinfra: write up clib_time_t
Describe the clock rate adjustment algorithm in detail

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I5bcab18efafe05cd1db9a4b01ce6a6ba66e383fa
2020-01-31 21:56:12 +00:00
John DeNisco
a273ce62d7 docs: Update the requirements and fix the build
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: I30e37f7e549083337b11ace95b4ff4f427d9fc8c
2020-01-24 14:05:17 -05:00
Benoît Ganne
87e64c929f docs: add AddressSanitizer mini-howto
Type: docs

Change-Id: I3bb589d04f15a03166a6d457552ffc316fb02f94
Signed-off-by: Benoît Ganne <bganne@cisco.com>
2020-01-23 15:53:35 +00:00
Jieqiang Wang
affa05532d docs: add physmem section in configuration parameters
physmem section is listed in 'Advanced Parameters', which has two
parameters, base-addr and max-size, for pmalloc module in VPP.

Type:feature

Change-Id: I7beef40603b864e4c8f3cf0fa716de74036cfdcc
Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
2019-12-18 22:47:42 +00:00
Paul Vinciguerra
917c91ada5 docs: update troubleshooting commands
Depends-On: https://gerrit.fd.io/r/c/vpp/+/22819

Type: docs

Change-Id: I1e2170a524e19cb91836a8073f62100b88f46cee
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-12-18 20:27:12 +00:00
Dave Barach
328631d4ee docs: improve compressed core file documentation
In particular, document "zcat vpp_core.gz | dd conv=sparse of=vpp_core"

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I01b70492ced864b47847c2ef7bc1ea8eb0980ec3
2019-12-17 09:36:06 -05:00
John DeNisco
4f85968a43 docs: Rework the startup configuration section
Type: docs

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic60aac96a4aeb5532f98dfb85c776bf549c0d660
Signed-off-by: Dave Barach <dave@barachs.net>
2019-12-11 20:41:24 +00:00
Dave Barach
87d24db65f classify: vpp packet tracer support
Configure n-tuple classifier filters which apply to the vpp packet
tracer.

Update the documentation to reflect the new feature.

Add a test vector.

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Iefa911716c670fc12e4825b937b62044433fec36
2019-12-05 15:31:57 +00:00
Dave Barach
d28437cdf2 classify: per-interface rx/tx pcap capture filters
Finish the feature, and fix a couple of doc bugs

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I2c62745fda137776204c8fc4fca0e7e288051573
2019-11-20 17:39:17 +00:00
Paul Vinciguerra
867b9ec6ab docs: update logging configuration section.
Type: docs

Change-Id: I6359623b2eadb404fc391e4c4608fff86020f53f
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-11-12 20:56:22 +00:00
John DeNisco
c96d618a5d docs: Rewrite the what is VPP (first) section, also fix the build
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ifb558171f8976a721703e74afea997d006273b5f
Signed-off-by: Dave Barach <dave@barachs.net>
2019-11-06 16:15:49 -05:00
Paul Vinciguerra
340c15c6ed docs: add spellcheck to 'make docs' sphinx docs
The CI gate will fail if there are typos in the docs.

  writing output... [ 21%] events/Summits/OpensourceSummit...
  writing output... [ 22%] events/Summits/UKNO/2017_04_30_...

  featuresbyrelease/vpp16.06.rst:34:Rasberry:vpp16.06
  writing output... [100%] usecases/vppinazure
  Spelling checker messages written to /vpp/docs/_build/html/output.txt

  Warning, treated as error:
  Found 1 misspelled words
  Makefile:31: recipe for target 'html' failed
  make[1]: *** [html] Error 2
  make[1]: Leaving directory '/vpp/docs'

If you introduce a term that is not recognized,
please add it to custom dictionary at
docs/spelling_wordlist.txt.

Type: feature

Change-Id: Id49be4fbee617f544f1ab8e78e7de8a4df36448b
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-11-06 17:53:42 +00:00
John DeNisco
73f725c63c docs: Fix warning with sphinx build, add script to publish docs
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic17585bcb4196e5b0661104745f67d6a02ab6b3d
2019-10-29 10:41:30 -04:00
Paul Vinciguerra
7fa3dd2881 docs: cleanup typos on readthrough
Type: style

Change-Id: I3b15035ea6c13cd1ca3cdc9dfa9b10a6e1be9880
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-10-28 13:51:13 +00:00
Nathan Skrzypczak
66f2a8891f docs: Add macos build documentation
Type: docs

Change-Id: Iee03aacab2cfcb4e87190302dc641e8273b7f096
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-10-09 13:18:47 +00:00
Dave Barach
56f62afe63 docs: grammar police raid
Edit the front-page intro text. Fix egregious grammar errors,
including an "it's" vs. "its" blunder.

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: If9d7d07899c402cd49bbae988110a15216035b02
2019-10-07 13:20:41 +00:00