summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2021-01-27Change unformat_init_string API in doc to match codehemant_mnkcg1-1/+2
Signed-off-by: hemant_mnkcg <hemant@mnkcg.com> Change-Id: I4ec487054f928d52fe06d530df095b30edf66ae5
2021-01-22docs: vpp stateless traffic generatorDave Barach2-0/+106
Add a use-case writeup. Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: Ib6e79e80455edbdeedcc96943dd98f16c57c559e
2021-01-20build: add the missing leading underscore to FORTIFY_SOURCENeale Ranns1-8/+8
Type: fix Signed-off-by: Neale Ranns <neale@graphiant.com> Change-Id: I36f2d08681f90a3f8ea7598952d1e14c53f0187b
2021-01-14docs: Update FIB documentationNeale Ranns22-183/+1392
Type: docs Signed-off-by: Neale Ranns <nranns@cisco.com> Change-Id: I3dfde4520a48c945ca9707accabbe1735c1a8799
2020-12-21docs: update list of pluginsPaul Vinciguerra4-13/+80
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>
2020-12-18docs: fix missing quotes in ubuntu install instructionsPaul Vinciguerra1-5/+5
type: docs Change-Id: Ifa09b63924f4b7bf2719bba6ada0e1122407641c Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-12-16docs: revise home gateway use-case documentationDave Barach3-286/+498
Switch to markdown format. Update docs to current production configs. Add remote software installation scripts. Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: Ieaf507a4393c1e4600fb40ae0722c52472bb0f8f
2020-12-07docs: Fix CentOS 8 buildJon Loeliger1-1/+7
Type: fix Signed-off-by: Jon Loeliger <jdl@netgate.com> Change-Id: I2d0d29af9186c50735d9a3b41148549f5cde614e
2020-11-26docs: fix bihash doc bugsDave Barach1-19/+19
Change hash -> hash_table in the pro forma main_t structure. Remove trailing whitespace. Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I10c310dded14d52ad09df7ca3a76e60f15266b6b
2020-11-24buffers: add page-size configNathan Skrzypczak1-0/+14
Type: feature Add a `buffers {page-size}` parameter to specify page size for buffers. This also fixes an issue with the parsing in unformat_log2_page_size. Change-Id: I7d7b1fa0bb7febaa7509cf2c625882f07eeafaad Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-11-16docs: fix memory troubleshooting docBenoît Ganne2-0/+4
Type: docs Change-Id: Id9f8f6f13e4a41567adf7dc68e6c9be42dd82de7 Signed-off-by: Benoît Ganne <bganne@cisco.com>
2020-11-10vpp: use vpp heap for libcBenoît Ganne1-0/+84
This makes libc use vpp main heap instead of the default libc heap. This gives better visibility (accounting, tracing) on allocations happening in external libraries called from vpp (eg. OpenSSL). Type: feature Change-Id: I5d8a673472145a4e090bedb443b8c58a967d1cca Signed-off-by: Benoît Ganne <bganne@cisco.com>
2020-10-16misc: deprecate VOMDamjan Marion1-1/+1
Type: make Change-Id: Ifb3e52af93d24fcc2f2e6a0c408e16902a2fe553 Signed-off-by: Damjan Marion <damarion@cisco.com>
2020-09-25docs: fix typo in bihash clib_bihash_search() documentationJon Loeliger1-2/+2
Type: docs Change-Id: Ic8c628141f8a24b857a654e2ea9129f5f97807b6 Signed-off-by: Jon Loeliger <jdl@netgate.com>
2020-09-21build: remove opensuse build infraDave Wallace5-75/+3
- VPP on opensuse has not been supported for several releases. Type: fix Signed-off-by: Dave Wallace <dwallacelf@gmail.com> Change-Id: I2b5316ad5c20a843b8936f4ceb473f932a5338d9
2020-09-16docs: improve plugin developer's guideDave Barach1-5/+55
Topics added: disabling lightly-used, experimental, or test plugins by default. Discourage folks from creating bihash tables, processes etc. from VLIB_INIT_FUNCTIONs. Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I1235d64971e9ed50f992b75f96b77c934168276a
2020-09-09docs: Improve new plugin doc & add govpp API docNathan Skrzypczak4-28/+142
Type: docs Change-Id: I5f20ac0232c5cdc3cf64015185b0d0fc5c4a3100 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-09docs: Update and improve indent installNathan Skrzypczak1-13/+28
Type: docs Change-Id: I1a37450261e0bcedf90685243b14027f3cf23704 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-09-05docs: Improve & link cnat docNathan Skrzypczak2-0/+2
Type: docs Change-Id: Ib985ed6a644ae3f4c330bf6a27dc69c49a489a2f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2020-08-13docs: correct fib tunnel diagram referenceChristian Hopps1-1/+1
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-07-28docs: Update the VPP tutorialJohn DeNisco2-12/+21
Update the documents for the VPP tutorial. Type: fix Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: I62d0641ff0af7b07a26b4379f19cbdaf285537d7
2020-07-06docs: Reflect the fact that the DPDK is now a pluginJohn DeNisco2-10/+27
Type: Improvement Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: Ic1253f601ee515392902a21b92e1dfd3962cc0a4
2020-06-23vlib: debug CLI macro expander, part deuxDave Barach1-0/+48
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-16vlib: address sanitizer support for stack switch, enable clangDamjan Marion1-5/+5
Type: improvement Change-Id: I81df4b61d1f0b8c1df77c1ee9bebcb491e155b69 Signed-off-by: Damjan Marion <damarion@cisco.com>
2020-06-03docs: improve handoff queue writeupDave Barach1-0/+196
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I4d63a0fbbdb3cc00eac9116f122e5b831d059e33
2020-05-29docs: Minor fixes in publish_docs.sh and sanitizer.rstJohn DeNisco2-0/+2
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-20docs: asan: update doc to match current statusBenoît Ganne1-5/+5
Type: docs Change-Id: I45265876c9c778f6b91d39f30eb6035f14d166ec Signed-off-by: Benoît Ganne <bganne@cisco.com>
2020-05-07misc: deprecate elftoolDamjan Marion1-1/+1
Type: make Change-Id: I34fec1c40ef660177c266517eaf41d60827609f4 Signed-off-by: Damjan Marion <damarion@cisco.com>
2020-05-06vppinfra: add timer wheel section to Sphinx docsDave Barach1-0/+117
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: Id0576d98b8e78cf4cd00161968d3eb6dbd58055a
2020-05-02vlib: add nosyslog unix optionRuslan Babayev1-0/+12
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-04-28docs: add missing spelling dictionaryPaul Vinciguerra1-0/+774
Type: docs Change-Id: I334312f8bfe2000d4613908c2a0ba7e6a39d3825 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-04-22misc: asan: disable leak sanitizer by defaultBenoît Ganne1-5/+3
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-09docs: Fix the Use Cases IndexJohn DeNisco1-15/+15
Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: If4d5ef8ab93c905493af074fb4c2096f1ab222d4
2020-04-02docs: Fix venv under python3Paul Vinciguerra5-19/+32
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-02docs: add a timebase precision sectionDave Barach1-0/+20
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I47434cb305f291a6221780ff4ee9a2c1bb041286
2020-03-27docs ethernet: add docs for ethernet SectionPaul Vinciguerra1-0/+14
Type: docs Change-Id: I6ad92b35df3e0fecb1334511625eacf3e3d8925f Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-27docs: minor typos in configuring/startup.rstPaul Vinciguerra1-2/+2
Change-Id: I8a6596d7cfa84cb2c5ee2d847395e9cea69c5349 Type: docs Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-27docs: document lxd container bootstrap procedureDave Barach1-0/+130
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I9cfa52637e813f2b990688b35634e3af10c58f6a
2020-03-23docs: add container functional test writeupDave Barach3-1/+512
Fix global copyright date Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I7f010d63ec010982f2c8c8388f14214fa6ced0a7
2020-03-23docs: Fix build on fresh ubuntu 18.04John DeNisco2-14/+23
Type: docs Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: If842c92183a9cf4b5a9773dced3298005b327e1a
2020-03-11docs: Add feature build to publish scriptJohn DeNisco2-3/+18
Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: I6a938f426b9a8e1242fa5c6f9716a3f9db4d4976
2020-03-11docs: describe clib_time monotonic timebase supportDave Barach1-1/+69
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I5b27d8b945472388498a4afc4be8dd868bb45ac3
2020-03-09docs: Add list of nodes for 'trace add'Paul Vinciguerra1-0/+22
(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-06docs: document the unformat '%_' optionPaul Vinciguerra1-0/+14
Type: docs Change-Id: Id864fcff768a78aa313b193f2eaabe545d95bec4 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-02-23vppinfra: deprecate CLIB_VEC64Dave Barach1-3/+1
Type: refactor Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: Id1e7c0926036db4601c91438397ceed22381fc07
2020-02-11http_static: VPP web application HowToDave Barach2-1/+275
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-01-31vppinfra: write up clib_time_tDave Barach1-0/+57
Describe the clock rate adjustment algorithm in detail Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I5bcab18efafe05cd1db9a4b01ce6a6ba66e383fa
2020-01-24docs: Update the requirements and fix the buildJohn DeNisco4-35/+37
Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: I30e37f7e549083337b11ace95b4ff4f427d9fc8c
2020-01-23docs: add AddressSanitizer mini-howtoBenoît Ganne2-0/+47
Type: docs Change-Id: I3bb589d04f15a03166a6d457552ffc316fb02f94 Signed-off-by: Benoît Ganne <bganne@cisco.com>
2019-12-18docs: add physmem section in configuration parametersJieqiang Wang1-4/+30
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>