aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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>
2019-12-18docs: update troubleshooting commandsPaul Vinciguerra1-2/+2
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-17docs: improve compressed core file documentationDave Barach1-5/+15
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-11docs: Rework the startup configuration sectionJohn DeNisco13-1979/+1377
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: Rewrite the what is VPP (first) section, also fix the buildJohn DeNisco32-555/+161
Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: Ifb558171f8976a721703e74afea997d006273b5f Signed-off-by: Dave Barach <dave@barachs.net>
2019-11-06docs: add spellcheck to 'make docs' sphinx docsPaul Vinciguerra17-59/+91
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-29docs: Fix warning with sphinx build, add script to publish docsJohn DeNisco2-1/+73
Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: Ic17585bcb4196e5b0661104745f67d6a02ab6b3d
2019-10-28docs: cleanup typos on readthroughPaul Vinciguerra51-102/+101
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-07docs: grammar police raidDave Barach1-7/+9
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-04docs: add packet-generator writeupDave Barach1-0/+183
Type: docs Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I4abb5c17e6fdfeaed5bbadb2ce83098dde6d05b1
2019-09-26misc: add vnet classify filter set supportDave Barach1-7/+20
Type: feature Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I79b216d2499df143f53977e5b70382f6f887e0bc
2019-09-23misc: unify pcap rx / tx / drop traceDave Barach1-8/+16
Use a single vnet_pcap_t in vlib_global_main, specifically to support unified tracing Update sphinx docs, doxygen tags Type: refactor Ticket: VPP-1776 Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: Id15d41a596712968c0714cef1bd2cd5bc9cbdd55
2019-09-20misc: classifier-based packet trace filterDave Barach1-0/+108
See .../src/vnet/classify/trace_classify.h for the business end of the scheme. It would be best to hash pkts, prefetch buckets, and do the primary table lookups two at a time. The inline as given works, but perf tuning will be required. "At least it works..." Add "classify filter" debug cli, for example: classify filter mask l3 ip4 src dst \ match l3 ip4 dst 192.168.2.10 src 192.168.1.10 Add "pcap rx | tx trace ... filter" to use the current classify filter chain Patch includes sphinx documentation and doxygen tags. Next step: device-driver integration Type: feature Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I05b1358a769f61e6d32470e0c87058f640486b26
2019-09-11docs: run-sphinx-docs-mergedjdenisco2-3/+3
Type: docs Signed-off-by: jdenisco <jdenisco@cisco.com> Change-Id: I571222f3e3672253930700e23cca4812dde84a6d
2019-09-09docs: improve unformat documentationDave Barach1-8/+120
Specifically: document the unformat specifiers "%=", "%|", and correct usage of unformat_line_input. Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I254f9c4a61c5c8d3edbf76f521e5f38fb89150f1
2019-08-26misc: 19.08 new featuresAndrew Yourtchenko2-0/+141
The full RELEASE.md diff is b610f2022c9f4e10a922e7b57c80ec77cd45d021 Change-Id: Ide6d85d41bdc836a03390a50ab94f6ebbaae0b28 Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com> (cherry picked from commit 1c586de48cc76fc6eac50f5d87003e2a80aa43e7)
2019-08-08docs: Add Ray's ACL use casejdenisco5-0/+489
Change-Id: Id99f16953a23a4be4cc1fb94419ea8282fa720e8 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-08-08api: api socket respect unix runtime directoryOle Troan1-2/+2
socksvr {} should respect the unix runtime directory. Default is now /run/vpp/api.sock The 'default' keyword is deprecated. The user is responsible for creating directories outside of the unix runtime directory. Not yet done: Exit VPP when socket cannot be opened. (currently only process exits). Type: fix Signed-off-by: Ole Troan <ot@cisco.com> Change-Id: I6dd66ed58a3d7e02674dfa16d72c1d7bba07b79e
2019-08-05docs: Add more quic plugin documentationNathan Skrzypczak4-0/+2
Type: docs Change-Id: I0209769f73a46ddad7c2625ad0f774ee2eef43dd Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-08-01docs: Small fixes and orderingNathan Skrzypczak3-0/+20
* deactivtates the TODOs on doxygen (were empty) * This move punt.md to readthedocs (should be the new place for dev doc ?) * Makes Handoff queue demo plugin a child of dev doc in doxygen Type: fix Change-Id: I1f0476a911b35208212af8dd608bc76160efd22a Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-07-26docs: add binary api trace replay detailsDave Barach1-7/+81
Folks need to know that they MUST carefully control the set of plugins to avoid feeding messages to the wrong binary API message handlers. Change-Id: Iefeeda6670aae4627446caee21717b847305c9b5 Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-22docs: improve home gateway use-case documentationDave Barach1-18/+131
Add plugin config, systemd config, netplan config, software installation via ssh, and a quick HowTo for setting up a double-nat test gateway. Fix a minor doc bug which caused a complaint on vpp-dev@lists.fd.io: /etc/vpp/startup.conf -> /setup.gate, but the vpp configuration file wasn't explicitly tagged with the name /setup.gate. Type: docs Change-Id: Ib219040d7c3c8b50ed66f8e9d3afd3dcf51b6b7b Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-19docs: Fix conf.py for read the docsjdenisco2-3/+2
Change-Id: Iaaf9e6ef5acc82fb751c851cc943cf0c48a8940d Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-07-12docs: add compressed core file descriptionDave Barach1-0/+27
To the issue reporting page Change-Id: I3d2b53521bcb1b9b4a85802a84427f17390f0f77 Type: docs Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-12docs: how to enable coredump with systemdBenoît Ganne1-0/+4
Type: docs Change-Id: I1f657389fec716cc6cdc942803e65f861ffea5f5 Signed-off-by: Benoît Ganne <bganne@cisco.com>
2019-06-27docs: Update the vhost sectionjdenisco4-8/+11
Change-Id: Ic7a144ffda0d0a3e0f6f9bc1a4790ab36fdf002e Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-30FIB: correctly report IPv6 FIB Unicast and Multicast memory usage (VPP-1578)"Neale Ranns3-2/+286
and document scaling Change-Id: I65d8999e65616d77e525963c770d91e9b0d5e593 Signed-off-by: Neale Ranns <nranns@cisco.com>