blob: 9b9a67fcf21c6f7679e8c81fdf6affb4c4ee22bc [file] [log] [blame]
John DeNisco06dcd452018-07-26 12:45:10 -04001.. _gstarteddevel:
2
John DeNiscoc4c72d22018-08-16 13:50:02 -04003###############
4For Developers
5###############
John DeNisco06dcd452018-07-26 12:45:10 -04006
John DeNiscoc64ba6d2018-08-02 15:03:15 -04007The Developers section covers the following areas:
8
John DeNisco2ba9dcf2018-08-23 14:04:22 -04009* Describes how to build different types of VPP images
10* Explains how to run VPP with and without GDB, with some GDB examples
11* Describes the steps required to get a patch reviewed and merged
12* Describes the VPP software architecture and identifies the associated four VPP layers
Dave Barachbcfcb8e2019-04-29 17:11:38 -040013* Describes the different components that are associated with each VPP layer
John DeNisco2ba9dcf2018-08-23 14:04:22 -040014* Explains how to Create, Add, Enable/Disable different ARC features
15* Discusses different aspects of Bounded-index Extensible Hashing (bihash), and how it is used in database lookups
16* Describes the different types of API support and how to integrate a plugin
John DeNiscoc64ba6d2018-08-02 15:03:15 -040017
John DeNisco06dcd452018-07-26 12:45:10 -040018.. toctree::
19 :maxdepth: 2
20
21 building
andrewa38d0012018-08-06 00:25:33 -040022 running_vpp
Dave Barach9292c322021-04-20 07:52:38 -040023 testing_vpp
andrewa38d0012018-08-06 00:25:33 -040024 gdb_examples
jdenisco390036e2018-10-31 14:24:31 -040025 add_plugin
Nathan Skrzypczakc4781a32020-09-04 18:31:23 +020026 add_plugin_goapi
John DeNisco758dc462018-08-13 17:00:06 -040027 gitreview
John DeNisco06dcd452018-07-26 12:45:10 -040028 softwarearchitecture
29 infrastructure
30 vlib
31 plugins
32 vnet
33 featurearcs
Dave Barachbcfcb8e2019-04-29 17:11:38 -040034 metadata
John DeNiscoce96dda2018-08-14 16:04:09 -040035 multiarch/index.rst
John DeNisco06dcd452018-07-26 12:45:10 -040036 bihash
andrew74030262018-08-05 21:18:45 -040037 vpp_api_module
38 binary_api_support
John DeNiscoce96dda2018-08-14 16:04:09 -040039 buildsystem/index.rst
John DeNisco2ba9dcf2018-08-23 14:04:22 -040040 eventviewer
jdenisco0923a232018-08-29 13:19:43 -040041 fib20/index.rst
Dave Barach01fdbcc2018-12-04 10:29:18 -050042 buildwireshark
Nathan Skrzypczak55c68c92019-07-29 11:18:05 +020043 punt
Nathan Skrzypczak7858d6e2019-07-29 13:51:31 +020044 quic_plugin
Nathan Skrzypczak66f2a882019-07-31 17:57:58 +020045 cross_compile_macos.rst
Nathan Skrzypczak24179ee2020-09-04 16:27:20 +020046 cnat
Nathan Skrzypczakc4781a32020-09-04 18:31:23 +020047 VPPAPI.md