aboutsummaryrefslogtreecommitdiffstats
path: root/doxygen
AgeCommit message (Collapse)AuthorFilesLines
2021-05-21doxygen: fix doxygen tagsDave Wallace2-1/+6
- Missing tags mess up doxygen TOC heirarchy Type: docs Signed-off-by: Dave Wallace <dwallacelf@gmail.com> Change-Id: I012d55c0ae90aecc665b56903f4212ddc0643943
2021-02-24docs: move pnat doc link into dev doc sectionDave Wallace1-1/+1
- "PNAT: 1:1 match and rewrite programmable NAT" link was hanging out on the top level of the doc tree. Move it to VPP->Developer Documentation. Type: fix Signed-off-by: Dave Wallace <dwallacelf@gmail.com> Change-Id: Iadb7d3463567a2414eece68db0a3743237ab26f9
2021-02-01docs: fix up the markdownAndrew Yourtchenko2-0/+3
Type: docs Change-Id: Ia541839e1f1ceddfae4579dece43b9cc820702e2 Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com> (cherry picked from commit de569048a504cf211d80b86882e6781684301790)
2020-12-16misc: Initial 21.06-rc0 commitv21.06-rc0Andrew Yourtchenko1-0/+3
Type:docs Change-Id: I07959a860194b06bb30455b6072d651058bb5d47 Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
2020-09-21build: remove opensuse build infraDave Wallace1-3/+0
- VPP on opensuse has not been supported for several releases. Type: fix Signed-off-by: Dave Wallace <dwallacelf@gmail.com> Change-Id: I2b5316ad5c20a843b8936f4ceb473f932a5338d9
2020-07-30docs: Add link to 20.05 test framework docsAndrew Yourtchenko1-0/+1
Change-Id: I429a29a5cb1f311bec4361c758b14b51b0afc8aa Type: docs Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com> (cherry picked from commit 765ef37670a4c32ccd3da345197e2b103d1a22b0)
2020-04-23misc: Markdown cleanups for the 20.01 releaseAndrew Yourtchenko2-1/+5
Type: docs Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com> Change-Id: I821197364a2fee9b52b1f014288b1f5e9e3c494c (cherry picked from commit fc98203b5d06f19d613766815660e76c9f216f09)
2020-04-06misc: fix python sonarcloud BLOCKER level issuesPaul Vinciguerra1-0/+1
Fix of the top 11 python issues flagged as BLOCKER. Ticket: VPP-1856 Type: fix Change-Id: Icf4691e62f4a69d6ee196b6d6e2ab52d961b5c76 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2020-03-10docs: doxygen fix siphon under python3Paul Vinciguerra1-3/+4
siphon used cgi.escape which was deprecated in python 3.2 and removed in python 3.8. Update the code to use html.escape instead. Type: fix Change-Id: I3192e3f69a4a95fe23cb24e1c29194ba5310932b Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-11-15build: fix docs/doxygen targetsDave Wallace1-2/+5
- Add missing dependencies - Fix clean/wipe to remove generated files - Fix doxygen src variable Type: fix Signed-off-by: Dave Wallace <dwallacelf@gmail.com> Change-Id: If6b2797e8af3f2e735759fab5841a0b4576ed7cc
2019-11-05docs: fix 'make doxygen' under python3Paul Vinciguerra13-74/+105
The 'make doxygen' component has this cool vpp specific customization called siphon. This updates the siphon component so that 'make doxygen' works with python3. Needed-By: https://gerrit.fd.io/r/23159 Type: docs Change-Id: Ie29f1602bf3460b637058acbb0a2f19b128a8824 Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-08-07docs: Add link to 20.01 test framework docsAndrew Yourtchenko1-0/+1
Change-Id: Ida11ed3dd70058cb618a7f9c137fde2e1e133a71 Type: docs Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
2019-08-01docs: Small fixes and orderingNathan Skrzypczak2-1/+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-03doxygen: improve .md file discoveryDave Barach1-0/+2
Add directories under .../src which contain .md files to DOXY_SRC_DIRECTORIES. Type: fix Change-Id: If7ce833b6cb9cd5ec30a8df8e263087e276cfe97 Signed-off-by: Dave Barach <dave@barachs.net>
2019-06-18ipsec: ipsec-tun protectNeale Ranns1-1/+0
please consult the new tunnel proposal at: https://wiki.fd.io/view/VPP/IPSec Type: feature Change-Id: I52857fc92ae068b85f59be08bdbea1bd5932e291 Signed-off-by: Neale Ranns <nranns@cisco.com>
2019-05-28docs: Add VPP API language documentationOle Troan1-0/+1
Initial commit of VPP API language documentation. Change-Id: Ied67203265319a8603086486c9031e723484c501 Signed-off-by: Ole Troan <ot@cisco.com>
2019-05-21docs: add quic subpage to user docsVratko Polak1-1/+2
+ Sort subpage list. + Fix copypaste error in quic doc label. Change-Id: Id8bdb4ad0d744f9886db3631ddad0e29bbb3c938 Signed-off-by: Vratko Polak <vrpolak@cisco.com>
2019-05-14rdma: update MAINTAINERS and add docBenoît Ganne1-0/+1
Change-Id: Ida681d299fd57eba66338444b99d2476bdb3c695 Signed-off-by: Benoît Ganne <bganne@cisco.com>
2019-05-01DOCS: Add link to 19.08 test framework docsDave Wallace1-0/+1
Change-Id: Ib0c3e3376152f4ec04e3689fb9ed94a859f1022f Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2019-05-01DOCS: Add link to 19.04 make test documentationDave Wallace1-0/+1
Change-Id: Iffa44b6a20f8446c94f8412e937ca40273aa8f2f Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2019-04-19Doxygen cleanup.Dave Wallace2-0/+7
- Add subpages definitions in appropriate section (User or Dev docs) for doc files (*.rst, *.md) that being listed at the top level of the generated doc page. - Generate and add API list to RELEASE doc. - Fix list_api_changes script to use HEAD as the endtag so it doesn't need to be changed every release. Change-Id: Iace7b6433359c6b96869cb1db01facbbcb0ac1e6 Signed-off-by: Dave Wallace <dwallacelf@gmail.com> (cherry picked from commit 11ee93f6abfaddf5bbd56cf0858c0c6ea0384b65)
2019-02-06Update to doxygen documentation for release 19.01Andrew Yourtchenko1-0/+1
Change-Id: Id19cefc24d391f0437a0355f5328505ec21aa58a Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com> (cherry picked from commit 44f14358cfe37a750f4541e5919b0c7877b6d46e)
2018-11-22Add RFC5424 syslog protocol support (VPP-1139)Matus Fabian1-0/+1
Syslog protocol logging transport event messages across network over UDP protocol based on RFC5426. Change-Id: Ica74b40bcc2e6d0fbd41e9bf78e76395fbabab3c Signed-off-by: Matus Fabian <matfabia@cisco.com>
2018-10-17Update to doxygen documentation for release 18.10Marco Varlese1-0/+2
Change-Id: Id8eebd59bad27ac3cc46bf993a5ca1d8410bf84c Signed-off-by: Marco Varlese <marco.varlese@suse.com> (cherry picked from commit 44c6ca6038776787671e78e3dae78e812c72429e)
2018-08-03API: Remove legacy vlibsocket code.Ole Troan1-1/+0
The API implementation now supports Unix domain sockets. The vlibsocket code has not been included in builds for a long time and is superfluous. Change-Id: I67a773d0e86e2318eacecf33f82d075553146ee9 Signed-off-by: Ole Troan <ot@cisco.com>
2018-04-30Add reference to 18.04 test framework documentationChris Luke1-1/+3
Change-Id: I0f24e0f0fde0568161edf52f40c5b83877ed7130 Signed-off-by: Chris Luke <chrisy@flirble.org>
2018-04-04Doc updates prior to branchChris Luke2-5/+9
Change-Id: Ibcffee7d20dbb79720199bcd82d2353f39d5544f Signed-off-by: Chris Luke <chrisy@flirble.org>
2018-02-02Add link to 18.01 test framework documentation.Dave Wallace1-0/+1
Change-Id: I030602391ea3b612ac9a6780399cc30b427cc3a5 Signed-off-by: Dave Wallace <dwallacelf@gmail.com> (cherry picked from commit 92b15bcea4c6c5e62415a8207463eb9a897630c6)
2018-01-30VPP-899: Run VPP under SELinuxBilly McFall2-1/+2
Add an SELinux profile such that VPP can run under SELinux on RPM based platforms. The SELinux Policy is currently only implemented for RPM packages, specifically, Fedora, CentOS and RHEL. Doxygen User Documentation has been included (selinux_doc.md). Once some discussion on file locations has completed (see vpp-devlist), updates to the Debug CLI documentation will also need to be updated. Additional changes: Patch Set 2: - Rework selinux_doc.md such that each line is only 80 characters instead of each sentence on a line. Made additonal minor chnages to the text. - Update vHost Debug CLI documentation to reflex new socket location. Cleaned up some text from when I originally wrote it, to better reflex proper use. - Update exec Debug CLI documentation to be more inline with suggested helptext, added text regarding recommended script file location. - For Debian builds, create the /var/log/vpp/ directory. I don't use Debian very much, so please pay extra attention to build-data/platforms.mk and build-root/deb/debian/.gitignore. - Per discussion on VPP call, changed the default log location to /var/log/vpp/vpp.log. - Changed the socket location for vHost in AutoConfig to /var/run/vpp/. Patch Set 3: - Update selinux_doc.md based on comments. Change-Id: I400520dc33f1ca51012d09ef8fe5a7b7b96c631e Signed-off-by: Billy McFall <bmcfall@redhat.com>
2018-01-24docs: Clean up TOCDave Wallace1-0/+2
Change-Id: I5415c002a431d84372f56d4a77dc2aabd6ef55f7 Signed-off-by: Dave Wallace <dwallacelf@gmail.com> (cherry picked from commit 1eb970d16028e9a987c1dd2bfe217d1313262b81)
2017-12-15apps: refactor uri and update build infraFlorin Coras1-1/+0
Change-Id: Ifa9966a27586a1a65038d069cf4a1e6e21a72d45 Signed-off-by: Florin Coras <fcoras@cisco.com>
2017-11-03Add C++ files to DoxygenChris Luke1-1/+1
Change-Id: Iab943988d1c714fe315e1dd13bd5d21f6bebdca1 Signed-off-by: Chris Luke <chrisy@flirble.org>
2017-09-28General documentation updatesChris Luke6-5/+23
- We now have several developer-focused docs, so create an index page for them. - Rework several docs to fit into the index structure. - Experiment with code highlighting; tweak the CSS slightly to make it slightly nicer to look at. Change-Id: I4185a18f84fa0764745ca7a3148276064a3155c6 Signed-off-by: Chris Luke <chrisy@flirble.org>
2017-09-25Add binary API documentationDave Barach1-0/+1
Change-Id: Id1a5da12b13d87bacfa81094f471b95db40c39be Signed-off-by: Dave Barach <dave@barachs.net>
2017-06-22NAT64: documentationMatus Fabian1-0/+1
added CLI command documentation added NAT64 user documentation page Change-Id: I3df400013800fe16351e02db7762ee3f92b195ff Signed-off-by: Matus Fabian <matfabia@cisco.com>
2017-06-09Sample plugin: Add sample plugin documentationRay Kinsella2-2/+2
Added some user documentation to sample plugin. Change-Id: I518910f80499307e8fcac8dcef7baaeab5ea8e35 Signed-off-by: Ray Kinsella <ray.kinsella@intel.com>
2017-05-30Flowprobe: Stateful flows and IPv6, L4 recordingOle Troan1-1/+1
Change-Id: I67839281623721bf42f0a918a53356143d9dc78a Signed-off-by: Ole Troan <ot@cisco.com> Signed-off-by: Pavel Kotucek <pkotucek@cisco.com> Signed-off-by: Ole Troan <ot@cisco.com>
2017-05-10doxygen: Fix some pathsChris Luke1-1/+3
- Add missing src dir. - Exclude 'src/examples' from siphon processing so that example cli commands don't end up in user documentation. Change-Id: I46a6ad759fa8220d305b007a9506956365fc79bd Signed-off-by: Chris Luke <chrisy@flirble.org>
2017-05-05First commit SR MPLSPablo Camarillo1-0/+1
Change-Id: I961685a2a0e4c314049444c64eb6ccf877c278dd Signed-off-by: Pablo Camarillo <pcamaril@cisco.com>
2017-03-29Bugfixing and documentation for SRv6Pablo Camarillo2-9/+10
- Fixed three coverity issues - Linked SRv6 docs - Moved sample plugin to examples folder - Fixed bug with hash. Now everything is using mhash. Potentially in the future we want to do bihash. Change-Id: Ie03a13c8fecb1e315e67d0596cbd23220779aaf2 Signed-off-by: Pablo Camarillo <pcamaril@cisco.com>
2017-02-22Add ref to test framework docs in doxygen output.Dave Wallace2-5/+8
Change-Id: If3081c4a9dde00cd522d1fc5a7daa9b1849684bf Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2017-02-02Added support for openSUSEMarco Varlese1-1/+4
Change-Id: I64a0eeaa066adb70dfaeb33641d0336ddac18cf0 Signed-off-by: Marco Varlese <marco.varlese@suse.com>
2017-01-11Remove vcgn pluginDamjan Marion1-2/+1
Change-Id: I79f18ec386dedd91a8dcea2ca5726208b7b3c67c Signed-off-by: Damjan Marion <damarion@cisco.com>
2017-01-10Revert "vppctl: bash completion for vppctl commands"Damjan Marion1-8/+17
This patch is causing build failures This reverts commit d995c757f05f78aa759b0a65c0a7e38088e690a9. Change-Id: I0c8d5a4208135d77aaa3a6a470d26140f7b74733 Signed-off-by: Damjan Marion <damarion@cisco.com>
2017-01-09vppctl: bash completion for vppctl commandsPadraig Connolly1-17/+8
Added bash completion that will include all commands from build time *Script takes list of commands generated by doxygen-siphon-list *Configured doxygen-siphon makefile to generate just cli commands *List of cli commands put in /usr/share/vpp *Stopped siphon using doxygen bootstrap, uses main bootstrap instead *Added rpm/deb check for installation of packages, separate from bootstrap *NOTE: Once you have installed the vpp .deb/.rpm package you will have to restart bash Change-Id: Ie503e80d5177481f6e7dbe59378f2e0d76f29152 Signed-off-by: Padraig Connolly <padraig.connolly@intel.com>
2017-01-01Move java,lua api and remaining plugins to src/Damjan Marion1-4/+3
Change-Id: I1c3b87e886603678368428ae56a6bd3327cbc90d Signed-off-by: Damjan Marion <damarion@cisco.com>
2016-12-28Repair Doxygen build infrastructureChris Luke2-11/+29
After Gerrit 4430 much of the documentation failed to build, but silently so it was easily missed; equally missing that several paths have been missing for a while. - Correct paths after directory tree changes. - Doxygen now bails when input paths don't exist. - Fix up some of the less deranged entries in the documentation index. - Exclude the LUA tree, its documentation is a mess. Change-Id: I35e6b433feee5e05bca772d93aa1635c724db734 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-11-28Add support for using documentation siphons in multiple waysChris Luke19-32/+199
Experiental support for generating multiple output formats from the same siphoned data. Adds a contrived example to generate a plain list of all CLI commands (the "itemlist" format). Eventually we can consider moving the tempate procesisng into the Output class as well as a way to override how the data is traversed (ordered). Change-Id: I77629a74a8fa0c7e583993469dc50491f72f13e7 Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-11-28dpdk: add ipsec cryptodev supportSergio Gonzalez Monroy1-0/+1
DPDK Cryptodev support and related IPsec ESP nodes using DPDK Cryptodev APIs. When DPDK Cryptodev support is enabled, the node graph is modified by adding and replacing some of the nodes. The following nodes are replaced: * esp-encrypt -> dpdk-esp-encrypt * esp-decrypt -> dpdk-esp-decrypt The following nodes are added: * dpdk-crypto-input : polling input node * dpdk-esp-encrypt-post : internal node * dpdk-esp-decrypt-post : internal node Change-Id: I6dca9a890abaf4fb2a4fffce3fd08ac013e4d701 Signed-off-by: Zhang, Roy Fan <roy.fan.zhang@intel.com> Signed-off-by: Sergio Gonzalez Monroy <sergio.gonzalez.monroy@intel.com>
2016-10-27Per-packet IPFIX record generation pluginDave Barach1-0/+1
Change-Id: Ia790aa018e70d67ed343e3e466d1b33b22560fc0 Signed-off-by: Dave Barach <dave@barachs.net>