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>
30 lines
1.2 KiB
ReStructuredText
30 lines
1.2 KiB
ReStructuredText
.. _developer-friendly:
|
|
|
|
===================
|
|
Additional features
|
|
===================
|
|
|
|
This section describes a little about the VPP environment and some of the features
|
|
that can be used by developers.
|
|
|
|
* Extensive runtime counters; throughput, `intructions per cycle <https://en.wikipedia.org/wiki/Instructions_per_cycle>`_, errors, events etc.
|
|
* Integrated pipeline tracing facilities
|
|
* Multi-language API bindings
|
|
* Integrated command line for debugging
|
|
* Fault-tolerant and upgradable
|
|
|
|
* Runs as a standard user-space process for fault tolerance, software crashes seldom require more than a process restart.
|
|
* Improved fault-tolerance and upgradability when compared to running similar packet processing in the kernel, software updates never require system reboots.
|
|
* Development experience is easier compared to similar kernel code
|
|
* Hardware isolation and protection (`iommu <https://en.wikipedia.org/wiki/Input%E2%80%93output_memory_management_unit>`_)
|
|
|
|
* Built for security
|
|
|
|
* Extensive white-box testing
|
|
* Image segment base address randomization
|
|
* Shared-memory segment base address randomization
|
|
* Stack bounds checking
|
|
* Static analysis with `Coverity <https://en.wikipedia.org/wiki/Coverity>`_
|
|
|
|
For the supported architectures click next.
|