9ad39c026c
This patch refactors the VPP sphinx docs in order to make it easier to consume for external readers as well as VPP developers. It also makes sphinx the single source of documentation, which simplifies maintenance and operation. Most important updates are: - reformat the existing documentation as rst - split RELEASE.md and move it into separate rst files - remove section 'events' - remove section 'archive' - remove section 'related projects' - remove section 'feature by release' - remove section 'Various links' - make (Configuration reference, CLI docs, developer docs) top level items in the list - move 'Use Cases' as part of 'About VPP' - move 'Troubleshooting' as part of 'Getting Started' - move test framework docs into 'Developer Documentation' - add a 'Contributing' section for gerrit, docs and other contributer related infos - deprecate doxygen and test-docs targets - redirect the "make doxygen" target to "make docs" Type: refactor Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com> Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
69 lines
1.6 KiB
ReStructuredText
69 lines
1.6 KiB
ReStructuredText
.. _packages:
|
|
|
|
Packages
|
|
==========
|
|
|
|
This section identifies the different VPP packages and describes their contents.
|
|
|
|
.. toctree::
|
|
|
|
vpp
|
|
---
|
|
|
|
Vector Packet Processing executables. This is the primary package that must be
|
|
installed to use VPP. This package contains:
|
|
|
|
* vpp - the vector packet engine
|
|
* vpp_api_test - vector packet engine API test tool
|
|
* vpp_json_test - vector packet engine JSON test tool
|
|
|
|
vpp-lib
|
|
-------
|
|
|
|
Vector Packet Processing runtime libraries. The *'vpp'* package depends on this
|
|
package, so it will always be installed. This package contains the VPP shared
|
|
libraries, including:
|
|
|
|
* vppinfra - Foundation library supporting vectors, hashes, bitmaps, pools, and string formatting.
|
|
* svm - vm library
|
|
* vlib - vector processing library
|
|
* vlib-api - binary API library
|
|
* vnet - network stack library
|
|
|
|
vpp-plugins
|
|
-----------
|
|
|
|
Vector Packet Processing plugin modules.
|
|
|
|
.. include:: ../../_generated/includes/plugin_list.inc
|
|
|
|
vpp-dbg
|
|
-------
|
|
|
|
Vector Packet Processing debug symbols.
|
|
|
|
vpp-dev
|
|
-------
|
|
|
|
Vector Packet Processing development support. This package contains
|
|
development support files for the VPP libraries.
|
|
|
|
vpp-api-python
|
|
--------------
|
|
|
|
Python binding for the VPP Binary API.
|
|
|
|
vpp-api-lua
|
|
-----------
|
|
|
|
Lua binding for the VPP Binary API.
|
|
|
|
vpp-selinux-policy
|
|
------------------
|
|
|
|
This package contains the VPP Custom SELinux Policy. It is only generated for
|
|
Fedora and CentOS distros. For those distros, the *'vpp'* package depends on
|
|
this package, so it will always be installed. It will not enable SELinux on
|
|
the system. It will install a Custom VPP SELinux policy that will be used if
|
|
SELinux is enabled at any time.
|