summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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>
2019-01-17DOC ONLY: wireshark dissector upstreamedDave Barach2-58/+48
Remove the last remnant from extra/wireshark, update the Sphinx docs Change-Id: I5886557f17192475c03fcb0dfde581e1e63cea5c Signed-off-by: Dave Barach <dave@barachs.net>
2019-01-07Update tcpdump / wireshark packet format writeupDave Barach1-6/+14
Change-Id: I8195bae1421f68a823b86e12373840f5292ac0df Signed-off-by: Dave Barach <dave@barachs.net>
2018-12-17docs: Add vmxmet3 driverjdenisco3-2/+131
Change-Id: I96425804c310a1ac1b7f5f12bb636e591c7bd429 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-12-17docs: clarify vector element alignment description.Dave Wallace1-5/+8
Change-Id: I6da153779010263e6fc4b51c64b01444aaadca17 Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2018-12-13docs: Update the requirementsjdenisco2-10/+10
Change-Id: I80ea8a65317805c6542e338a92a21e6090f6c015 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-12-06nsim: add packet loss simulation, docsDave Barach2-1/+91
Change-Id: Ic9747541aad8148ebf7d520b525b99c4cc3961f3 Signed-off-by: Dave Barach <dave@barachs.net>
2018-12-06DOC-ONLY: MFIB documentationNeale Ranns4-5/+96
Change-Id: I8c7277584f231dd4732a4c6013e156a5bb821f41 Signed-off-by: Neale Ranns <nranns@cisco.com>
2018-12-05DOC ONLY: describe dispatch pcap tracingDave Barach3-2/+263
and wireshark dissection of these traces. Change-Id: I61029fd20d6d5f6c40638e3ea9223f2354abedba Signed-off-by: Dave Barach <dave@barachs.net>
2018-11-27docs: Add more on trexjdenisco7-22/+225
Change-Id: Ifb5eabe30e1b0ba911ddf455573cc346ff4bec85 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-23doc: delete wrong description since VPP support 1G hugepageYulong Pei1-3/+3
Change-Id: Ib673f8059f47d8e2e86ad810a354ddf630f557cf Signed-off-by: Yulong Pei <yulong.pei@intel.com>
2018-11-13docs and Config utility, package cloud supportjdenisco2-2/+6
Change-Id: I61303242b73e509df42dedba54f2ee5906a7e526 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-13vlib rename vlib_frame_args(...) to vlib_frame_scalar_args(..)Damjan Marion1-1/+1
Typically we have scalar_size == 0, so it doesn't matter but vlib_frame_args was providing pointer to scalar frame data, not vector data. To avoid future confusion function is renamed to vlib_frame_scalar_args(...) Change-Id: I48b75523b46d487feea24f3f3cb10c528dde516f Signed-off-by: Damjan Marion <damarion@cisco.com>
2018-11-12docs: add 1810, including package cloudjdenisco10-131/+178
Change-Id: Ieae5fc7c1e099392bc2a4e5948669d9210f2ebac Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-06docs: Add version and build datejdenisco3-0/+15
Change-Id: I6fd53d3ef12e4b6f1af1e5605c09938bce324ec9 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-06docs: Small changes to plugin, updated the requirementsjdenisco4-47/+32
Change-Id: I3c05a28991d01e726d4fa8580a720359a2d4ce91 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-10-30DOC-ONLY: document packet intialization from scratchDave Barach2-40/+126
Minor clean-up in the home gateway use-case documentation Change-Id: I7d3aaea8cec62248daf7814b21a8acb574ac12a1 Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-30docs: Add VPP with iperf and trexjdenisco12-3/+554
Change-Id: I9f238b6092bc072fd875facfee5262c6b155043e Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-10-30DOC-ONLY: upgrade the "requests" packageDave Barach1-1/+1
requests 2.18.4 is the subject of a security alert Change-Id: Id1e9338d86bced8c0bb065db7b3dc7f02aa41afc Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-26docs: add useful debug CLI Review UpdatesScott Keeler12-733/+755
Change-Id: I4ebd977672090f2a7fc08bb139832df39614564a Signed-off-by: Scott Keeler <skeeler@cisco.com>