summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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>
2018-10-24docs: add useful debug CLIScott Keeler16-249/+1058
Change-Id: I5ef9ecd741f1623ae1b7a23fa0a4fa6db7e243a3 Signed-off-by: Scott Keeler <skeeler@cisco.com>
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-22add Contiv-VPP installation guidance on Aarch64Lijian Zhang1-0/+10
add Contiv-VPP installation guidance on Aarch64 Change-Id: I323c871d346c47396916a618934c5e169ee49212 Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com> Reviewed-by: Song Zhu <Song.Zhu@arm.com> Reviewed-by: Trevor Tao <Trevor.Tao@arm.com> Reviewed-by: Sirshak Das <Sirshak.Das@arm.com> Reviewed-by: Tina Tsou <Tina.Tsou@arm.com>
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-10-05docs: add contiv vppScott Keeler19-0/+2632
Change-Id: I92227fc4968fc6a478beb7f38707b91e9f0635ec Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-24Add the sphinx docs build optionsjdenisco2-8/+26
Change-Id: If7ac5b41ca4ac602a100b616b37d07f658fd6a90 Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-18docs: Added Related Projects and Archivejdenisco4-10/+102
Change-Id: I9a6076aa53d810ec44761d9f9459eb91f2c05974 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-07docs: what is vpp and features and performanceScott Keeler10-29/+54
Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46 Signed-off-by: Scott Keeler <skeeler@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: Add features by release sectionScitt Keeler12-0/+706
Change-Id: Ibcae8c8ecdf8a3c2d7bcf96bf7cd5b741e2fad22 Signed-off-by: Scitt Keeler <skeeler@cisco.com>
2018-08-30docs: FIB 2.0 startjdenisco26-1/+745
Change-Id: I87cd2eae133c9f5b9f7764a0f7a41bcc28523e4c Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-08-27docs: Finish event logger, viewer and cleanup.John DeNisco17-142/+346
Change-Id: I3de038439bf0ab5755777c0f4930aec0514f5b63 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17docs: Moved installing up a level, removed guides.John DeNisco14-98/+25
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17Update AArch64 CSIT machines into FD.io VPP docsLijian Zhang2-2/+11
The outlook will appear as below. The FD.io CSIT is implemented with below platforms: x86/64 ARM-AArch64 Huawei TaiShan 2280 Marvell MACCHIATObin Change-Id: Ie84a99c53a0fc2186ea6992baca9558b6d96c7f8 Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
2018-08-17docs: Rework the VPP progressive Tutorial.John DeNisco21-471/+394
Change-Id: If5b0d07ea90d978c6b1f11210a661876b7929653 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14DOCS: Moved multiarch and build system, Incorprated Scott's changesJohn DeNisco25-101/+130
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 DeNisco11-253/+97
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-10DOC-ONLY: document latest multi-arch support schemeDave Barach3-0/+172
Signed-off-by: Dave Barach <dave@barachs.net> Change-Id: I613415c109f648248ee04dd76d5e652dbf21bc7f
2018-08-10DOC-ONLY: build system detailsDave Barach5-0/+382
The tables need some TLC from someone familiar with making pretty tables. Fixed text-wrapping onto newlines for all tables in our docs. Changed Environment Variables to ENV Variables so that the specific column header fits properly. Change-Id: Ie758612e561eefe44e771dac63b63bf026a52c2d Signed-off-by: Dave Barach <dave@barachs.net>
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)andrew7-53/+60
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-09DOCS: Restructure EventsJohn DeNisco93-866/+270
Change-Id: I135ced20b58cdb72fbd0784015af037bb6e7ad28 Signed-off-by: John DeNisco <jdenisco@cisco.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 DeNisco13-1352/+1372
docs: Incorporate Javier's progressive VPP tutorial Change-Id: Iecee041039c7ed81713bc0530fc536e989c71497 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-03docs: Incororate Scott's overall reviewJohn DeNisco22-78/+146
Change-Id: Ic70a62e17891fa9291a5274400ae89f1d6194b6e Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-01docs: change code blocks from "shell" to "console"John DeNisco7-47/+47
Change-Id: I136fccfc06e07fb68d11df686c59687362fb8827 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-27Fix .gitignore so docs/Makefile is not ignored. Add README and Makefile. Fis ↵John DeNisco3-11/+80
gitreview. Change-Id: I3d664d9c881ce127a09b9d68c1181a7098a39074 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26Initial commit of Sphinx docsJohn DeNisco237-56/+12729
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-11Documentation: Placeholder directory and filesEd Kern1-0/+56
This adds the directory sphinx and sphinx/docs as well as two matching placeholder files. These are being added now to facilitate some gerrit triggers Change-Id: I0e6e7607c5ae5cdbf05718b95b1d299178544485 Signed-off-by: Ed Kern <ejk@cisco.com>