summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted
AgeCommit message (Collapse)AuthorFilesLines
2022-06-29docs: fix broken linksPratikshya Prasai1-11/+11
Type: docs Signed-off-by: Pratikshya Prasai <pratikshyaprasai2112@gmail.com> Change-Id: I729de9e18624c63a72ec415a05c55617cb360c47 (cherry picked from commit 365fabea1eac892b838a258d39e6e6eee8adbd2d)
2021-10-13docs: better docs, mv doxygen to sphinxNathan Skrzypczak92-11238/+364
This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
2021-09-28api: API trace improvementsFilip Tehlar1-6/+5
Type: improvement * add support for JSON format in API trace * add ability to replay JSON API trace in both VPP and VAT2 * use CRC for backward compatibility check during JSON API replay * fix API trace CLI (and remove duplicits) * remove custom dump * remove vppapitrace.py * update docs accordingly Change-Id: I5294f68bebe6cbe738630f457f3a87720e06486b Signed-off-by: Filip Tehlar <ftehlar@cisco.com> Signed-off-by: Ole Troan <ot@cisco.com>
2021-08-13tests docs: upgrade python packagesDave Wallace1-0/+1
- Upgrade python package requirements for test & docs - Clean up docs generation warnings - Consolidate python requirements for docs in test requirements specs. - Upgrade pip Type: make Change-Id: I74a3924b43ed93d15b32ec9f6fc41ed1ba95b69b Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2021-07-02ipsec: ADD/update IPSec documentationNeale Ranns1-0/+1
Type: docs Signed-off-by: Neale Ranns <nranns@cisco.com> Change-Id: Ica576e13953a3c720a7c093af649d1dd380cc2c0
2021-05-14vlib: pass node runtime to vlib_buffer_enqueue_to_thread()Damjan Marion1-1/+1
Mechanical change for patch following this one... Type: improvement Change-Id: Iee12f3a8851f35569e6c039494a94fc36e83d20f Signed-off-by: Damjan Marion <damarion@cisco.com>
2021-05-01vlib: refactor trajectory trace debug featureBenoît Ganne1-4/+1
trajectory trace has been broken for a while because we used to save the buffer trajectory in a vector pointed to in opaque2. This does not work well when opaque2 is copied (eg. because of a clone) as 2 buffers end up sharing the same vector. This dedicates a full cacheline in the buffer metadata instead when trajectory is compiled in. No dynamic allocation, no sharing, no tears. Type: refactor Change-Id: I6a028ca1b48d38f393a36979e5e452c2dd48ad3f Signed-off-by: Benoît Ganne <bganne@cisco.com>
2021-04-21docs: document "make test-help"Dave Barach2-0/+142
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I67a582b7bf16c3fe307941973e983a0fe28cb221
2021-03-04docs: Update macos doc to clang-formatNathan Skrzypczak1-15/+13
Type: docs Change-Id: Ibf825ac8b1591e8109be0b3b8d56ee85ae5145a4 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2021-02-12docs: fixing VPP tutorialArthur de Kerhor3-6/+6
Updating ARP table command. Type: fix Signed-off-by: Arthur de Kerhor <arthurdekerhor@gmail.com> Change-Id: I02d6ac86aed4c83430f9d07bdeaa3e0f5c3ae73f
2021-01-28build: do not _FORTIFY_SOURCE in debug modeMohammed Hawari1-3/+3
When compiling in -O0, the glibc feature.h ignores _FORTIFY_SOURCE and, in some distributions, throws a #warning, which fails the build. This patch removes -D_FORTIFY_SOURCE in all debug configurations. Change-Id: Ic30229c038353e49ff9419779e082a7083c1ea5f Type: fix Signed-off-by: Mohammed Hawari <mohammed@hawari.fr>
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-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 Ranns20-181/+1390
Type: docs Signed-off-by: Neale Ranns <nranns@cisco.com> Change-Id: I3dfde4520a48c945ca9707accabbe1735c1a8799
2020-12-21docs: update list of pluginsPaul Vinciguerra1-13/+1
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-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-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 Wallace3-69/+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 DeNisco1-10/+19
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 DeNisco1-1/+16
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-03docs: improve handoff queue writeupDave Barach1-0/+196
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I4d63a0fbbdb3cc00eac9116f122e5b831d059e33
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-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-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-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
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>
2019-12-11docs: Rework the startup configuration sectionJohn DeNisco11-1973/+1374
Type: docs Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: Ic60aac96a4aeb5532f98dfb85c776bf549c0d660 Signed-off-by: Dave Barach <dave@barachs.net>
2019-12-05classify: vpp packet tracer supportDave Barach1-3/+10
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-11-20classify: per-interface rx/tx pcap capture filtersDave Barach1-5/+13
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-12docs: update logging configuration section.Paul Vinciguerra1-10/+10
Type: docs Change-Id: I6359623b2eadb404fc391e4c4608fff86020f53f Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-11-06docs: add spellcheck to 'make docs' sphinx docsPaul Vinciguerra4-6/+6
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-10-28docs: cleanup typos on readthroughPaul Vinciguerra25-56/+56
Type: style Change-Id: I3b15035ea6c13cd1ca3cdc9dfa9b10a6e1be9880 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-10-09docs: Add macos build documentationNathan Skrzypczak2-0/+58
Type: docs Change-Id: Iee03aacab2cfcb4e87190302dc641e8273b7f096 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-10-04docs: add packet-generator writeupDave Barach1-0/+183
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I4abb5c17e6fdfeaed5bbadb2ce83098dde6d05b1