aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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>
2019-05-28docs: Add some packages for building the docsjdenisco2-2/+13
Change-Id: I7af427ba6378ddd8480a153a65ec11c578bab12e Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-17docs: Fix Versions and Titlesjdenisco4-7/+7
Change-Id: I131e33a570bff8b22c767585d03e2eb281dd7184 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-16docs: Update sphinx, requirements, support markdown tablesjdenisco9-30/+50
Change-Id: Ie7c546f5720b10fe5423397204e1ab5c22d7a2ba Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-16DOC ONLY: document VLIB_INIT_FUNCTION schemeDave Barach1-4/+49
Change-Id: I15c4256621da6c8d47b1a7c41755ee6587996757 Signed-off-by: Dave Barach <dave@barachs.net>
2019-05-10docs: Add 1904jdenisco6-17/+133
Change-Id: Icf0e01d1dec69d48664ed633205248359b653f4d Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-04-30Sphinx docs: Fix security vulnerability (VPP-1655)Dave Wallace1-1/+1
Change-Id: I9b11d15866d708eb843936ebfd120940d284a2de Signed-off-by: Dave Wallace <dwallacelf@gmail.com> (cherry picked from commit facb4d44475cd0040cc8964be30180e1adeb2021)
2019-04-29DOC ONLY: add a buffer metadata writeupDave Barach2-1/+192
Change-Id: Ic8034cfe3d3c5a9c3d32e97e93e5d9334cc58ca2 Signed-off-by: Dave Barach <dave@barachs.net>
2019-04-25docs: Add VPP inside the CloudFrancesco Spinelli9-4/+805
This commit updates the VPP docs, adding the VPP deployment and configuration inside the cloud Change-Id: I97322deb57f0dfb1aa46cca301adbc91ce4a19f6 Signed-off-by: Francesco Spinelli <francescospinelli94@live.it>
2019-04-08fixing typosJim Thompson1-1/+1
Change-Id: I215e1e0208a073db80ec6f87695d734cf40fabe3 Signed-off-by: Jim Thompson <jim@netgate.com>
2019-03-22DOC-ONLY: improve multi-arch documentationDave Barach2-0/+88
Document CLIB_MARCH_FN and CLIB_MARCH_FN_SELECT Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I661ba2af79db8205d70fa87203d40a2e31b795e4
2019-03-21docs: break up long lines in vmxnet3.rst to avoid line wrapSteven Luong1-21/+34
Although it does not make a difference for the formatter with long lines, it is easier to view and read the raw text with conventional editor when there no line wrap. Just break up the long lines to 80 characters or less. Change-Id: Ia916638e974abd19b8d19aee4dd72ff6a243ca48 Signed-off-by: Steven Luong <sluong@cisco.com>
2019-03-19docs: Update vmxnet3 usecaseSteven Luong1-12/+36
Update vmxnet3 usecase to reflect the current supported features. Change-Id: I4558eb422d5b2641b3acfc7c0a3734bf31a8fb0f Signed-off-by: Steven Luong <sluong@cisco.com>
2019-03-15DOC ONLY: fix g2 build documentationDave Barach2-49/+44
Removed a broken paragraph, replaced it with a link. Some nuisance white-space cleanups courtesy of emacs: (add-hook 'before-save-hook 'delete-trailing-whitespace) Change-Id: Ib348107c2dc0df8249461591015347d7b4f6fa4a Signed-off-by: Dave Barach <dave@barachs.net>
2019-03-12DOC ONLY: add packet handoff docDave Barach1-11/+117
Change-Id: I2e8076bb4f697819780e61ff761defdc74bf4f09 Signed-off-by: Dave Barach <dave@barachs.net>
2019-02-27Fix centos build and build documentationjdenisco3-4/+4
Change-Id: I326204d26b613254e39c6a0ffe9f9491981ba3c3 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-27DOC ONLY: update bug report sectionDave Barach1-31/+58
More detail on why it's important to supply .debs or .rpms which precisely match core files. Probably won't help, but we can try... Change-Id: I7842eaea0ef921b934e84b7f18f6a333b1381292 Signed-off-by: Dave Barach <dave@barachs.net>
2019-02-23Add support for 19.01jdenisco3-74/+15
Change-Id: I8583f6f6432d8d7c449f43d62d8707a1718f3240 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-20docs: use python3 for make docs.Paul Vinciguerra1-3/+3
Change-Id: If62b5ef563523b400fb5160d0343210407905094 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-02-19VPP-1504: Remove JVPPMichal Cmarada8-61/+6
As part of JVPP migration this removes JVPP completely from VPP. Change-Id: I6b74e7961aa474ae471e63fe43a624cd9fc3659b Signed-off-by: Michal Cmarada <mcmarada@cisco.com>
2019-01-31docs: Instructions for using vmxnet3 on macjdenisco2-2/+24
Change-Id: Ie6770e3a3801a23a6eb64cf1699ef0018eab6445 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-01-20buffers: don't init metadata, as it is already initializedDamjan Marion1-3/+0
Change-Id: Ia083050389853c25b069f0f8286d50d3f4aef527 Signed-off-by: Damjan Marion <damarion@cisco.com>