summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted
AgeCommit message (Collapse)AuthorFilesLines
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-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-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 Skrzypczak2-0/+2
Type: docs Change-Id: I0209769f73a46ddad7c2625ad0f774ee2eef43dd Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-08-01docs: Small fixes and orderingNathan Skrzypczak2-0/+2
* 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-05-30FIB: correctly report IPv6 FIB Unicast and Multicast memory usage (VPP-1578)"Neale Ranns2-0/+284
and document scaling Change-Id: I65d8999e65616d77e525963c770d91e9b0d5e593 Signed-off-by: Neale Ranns <nranns@cisco.com>
2019-05-28docs: Add some packages for building the docsjdenisco1-0/+11
Change-Id: I7af427ba6378ddd8480a153a65ec11c578bab12e Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-16docs: Update sphinx, requirements, support markdown tablesjdenisco2-2/+12
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 1904jdenisco2-15/+9
Change-Id: Icf0e01d1dec69d48664ed633205248359b653f4d Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-04-29DOC ONLY: add a buffer metadata writeupDave Barach2-1/+192
Change-Id: Ic8034cfe3d3c5a9c3d32e97e93e5d9334cc58ca2 Signed-off-by: Dave Barach <dave@barachs.net>
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-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 documentationjdenisco2-2/+2
Change-Id: I326204d26b613254e39c6a0ffe9f9491981ba3c3 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-23Add support for 19.01jdenisco2-72/+13
Change-Id: I8583f6f6432d8d7c449f43d62d8707a1718f3240 Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-19VPP-1504: Remove JVPPMichal Cmarada6-13/+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-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: clarify vector element alignment description.Dave Wallace1-5/+8
Change-Id: I6da153779010263e6fc4b51c64b01444aaadca17 Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2018-12-06DOC-ONLY: MFIB documentationNeale Ranns3-3/+94
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-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 supportjdenisco1-0/+4
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 cloudjdenisco2-119/+115
Change-Id: Ieae5fc7c1e099392bc2a4e5948669d9210f2ebac Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-06docs: Small changes to plugin, updated the requirementsjdenisco2-8/+17
Change-Id: I3c05a28991d01e726d4fa8580a720359a2d4ce91 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-10-30DOC-ONLY: document packet intialization from scratchDave Barach1-0/+121
Minor clean-up in the home gateway use-case documentation Change-Id: I7d3aaea8cec62248daf7814b21a8acb574ac12a1 Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-24DOC ONLY: fix doc bugsDave Barach2-40/+44
multiarch support: change autotools -> cmake getting a patch reviewed: improve patch conflict resolution section Change-Id: I2f07e1d3f21dd8cefb4d4bb3b451965d9314211a Signed-off-by: Dave Barach <dave@barachs.net>
2018-10-05DOC ONLY: clean up plugin documentationDave Barach4-175/+277
The old "sample_plugin" page was stuffed with superceded autotools build information, so it morphed into an "add a new plugin" page based on the emacs-lisp plugin generator. Before sending hate mail about emacs, please *look* at the new document: you'll find running the plugin generator hard to tell from running a shell script. Change-Id: I84da45675e838c05faeca05c8f7be45d8c7bff13 Signed-off-by: Dave Barach <dave@barachs.net>
2018-09-24Add the sphinx docs build optionsjdenisco1-8/+12
Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-12Always use 'lib' instead of 'lib64'Damjan Marion3-4/+4
It is packaging responsibility to put libs in the right place. Use of lib64 resulted in huge amount of files with hardcoded lib64. This patch simplifies things... Change-Id: Iab0dea0583e480907732c5d2379eb951a00fa9e6 Signed-off-by: Damjan Marion <damarion@cisco.com>
2018-09-06DOC ONLY: cmake / ninja build system docDave Barach2-1/+188
Change-Id: I69cdcf3f0940f8a5f60203034688a0c63446f65c Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-31Docs: update MPLS FIB section with text from the wikiNeale Ranns1-49/+152
Change-Id: I9d903db89facc916fb5dd23d564417230e1c76e0 Signed-off-by: Neale Ranns <nranns@cisco.com>
2018-08-30docs: FIB 2.0 startjdenisco15-1/+745
Change-Id: I87cd2eae133c9f5b9f7764a0f7a41bcc28523e4c Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-08-27docs: Finish event logger, viewer and cleanup.John DeNisco8-142/+346
Change-Id: I3de038439bf0ab5755777c0f4930aec0514f5b63 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17docs: Moved installing up a level, removed guides.John DeNisco7-18/+21
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17docs: Rework the VPP progressive Tutorial.John DeNisco14-16/+1314
Change-Id: If5b0d07ea90d978c6b1f11210a661876b7929653 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14DOCS: Moved multiarch and build system, Incorprated Scott's changesJohn DeNisco21-90/+661
Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14DOCS: Updated startup.conf parametersandrew1-69/+174
Change-Id: Id1f4ff7409e8a833b8f7e6030d7287d8c1274c2d Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-13DOCS: Cleanup Getting StartedJohn DeNisco8-612/+53
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-10docs: A little cleanup and added some gdb examples.andrew4-18/+210
docs: Added section on running VPP for developers. Change-Id: I98b5c6f1c9fee60b297e3947e78ec33f950f598a Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-09DOCS: General cleanup (did not move any sections)andrew4-16/+21
Change-Id: I67cc42769661c10d2793f8c6cdb3b232b803d145 Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-09DOCS: modified writing docs sectionjavierfernandezvalles1-1/+1
Change-Id: Ic3ec16dba1a6374785f25f622b2cdc9b6415a13b Signed-off-by: javierfernandezvalles <JaviervallesF@gmail.com>
2018-08-08DOC ONLY: Add a new doc for integrating a plugin with VPPandrew4-0/+710
Convert doxygen docs (vpp api module and binary api support) to .rst Added a brief explanation of binary api message numbering for plugins Change-Id: If7d37f29aa65a884b51f3d27957f80d1357ed29b Signed-off-by: andrew <andrew.olechtchouk@gmail.com> Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-07docs: Cleaned up a little removed instructions for mac.andrew1-22/+89
docs: Updated section on using git-review Change-Id: I180f67e3478b57b1de03df95fc67a0cfdd44dfb5 Signed-off-by: andrew <andrew.olechtchouk@gmail.com>
2018-08-07DOC ONLY: document bihash table walker rulesDave Barach1-0/+35
Change-Id: I0c48e0f4b87065d8f42009e2cc9709c6b7f5e851 Signed-off-by: Dave Barach <dave@barachs.net>
2018-08-03Added missing fileJohn DeNisco3-8/+6
docs: Incorporate Javier's progressive VPP tutorial Change-Id: Iecee041039c7ed81713bc0530fc536e989c71497 Signed-off-by: John DeNisco <jdenisco@cisco.com>