Sample plugin: Add sample plugin documentation - vpp

diff options

author	Ray Kinsella <ray.kinsella@intel.com>	2017-06-08 15:54:19 +0100
committer	Chris Luke <chris_luke@comcast.com>	2017-06-09 16:34:40 +0000
commit	583dc8d3e23a780c85ebe48ea59f0338aad4df17 (patch)
tree	c52c9ef7a020b0cce27917bc5e3a6a09f4423639 /doxygen
parent	7d5fae861ed243983155ade90c81fc27a47bf376 (diff)

Sample plugin: Add sample plugin documentation

Added some user documentation to sample plugin. Change-Id: I518910f80499307e8fcac8dcef7baaeab5ea8e35 Signed-off-by: Ray Kinsella <ray.kinsella@intel.com>

Diffstat (limited to 'doxygen')

-rw-r--r--

doxygen/Makefile

-rw-r--r--

doxygen/user_doc.md

2 files changed, 2 insertions, 2 deletions

Vector Packet Processing ======================== ## Introduction The VPP platform is an extensible framework that provides out-of-the-box production quality switch/router functionality. It is the open source version of Cisco's Vector Packet Processing (VPP) technology: a high performance, packet-processing stack that can run on commodity CPUs. The benefits of this implementation of VPP are its high performance, proven technology, its modularity and flexibility, and rich feature set. For more information on VPP and its features please visit the [FD.io website](http://fd.io/) and [What is VPP?](https://wiki.fd.io/view/VPP/What_is_VPP%3F) pages. ## Changes Details of the changes leading up to this version of VPP can be found under @ref release_notes. ## Directory layout Directory name | Description ---------------------- | ------------------------------------------- build-data | Build metadata build-root | Build output directory doxygen | Documentation generator configuration dpdk | DPDK patches and build infrastructure @ref src | VPP source code @ref src/plugins | VPP bundled plugins directory @ref src/svm | Shared virtual memory allocation library src/tests | Unit tests src/vat | VPP API test program @ref src/vlib | VPP application library @ref src/vlibapi | VPP API library @ref src/vlibmemory | VPP Memory management @ref src/vlibsocket | VPP Socket I/O @ref src/vnet | VPP networking @ref src/vpp | VPP application @ref src/vpp-api | VPP application API bindings @ref src/vppinfra | VPP core library test | Unit tests @ref src/vpp/api | Not-yet-relocated API bindings @ref src/examples | VPP example code ## Getting started In general anyone interested in building, developing or running VPP should consult the [VPP wiki](https://wiki.fd.io/view/VPP) for more complete documentation. In particular, readers are recommended to take a look at [Pulling, Building, Running, Hacking, Pushing](https://wiki.fd.io/view/VPP/Pulling,_Building,_Run ning,_Hacking_and_Pushing_VPP_Code) which provides extensive step-by-step coverage of the topic. For the impatient, some salient information is distilled below. ### Quick-start: On an existing Linux host To install system dependencies, build VPP and then install it, simply run the build script. This should be performed a non-privileged user with `sudo` access from the project base directory: ./extras/vagrant/build.sh If you want a more fine-grained approach because you intend to do some development work, the `Makefile` in the root directory of the source tree provides several convenience shortcuts as `make` targets that may be of interest. To see the available targets run: make ### Quick-start: Vagrant The directory `extras/vagrant` contains a `VagrantFile` and supporting scripts to bootstrap a working VPP inside a Vagrant-managed Virtual Machine. This VM can then be used to test concepts with VPP or as a development platform to extend VPP. Some obvious caveats apply when using a VM for VPP since its performance will never match that of bare metal; if your work is timing or performance sensitive, consider using bare metal in addition or instead of the VM. For this to work you will need a working installation of Vagrant. Instructions for this can be found [on the Setting up Vagrant wiki page] (https://wiki.fd.io/view/DEV/Setting_Up_Vagrant). ## More information Several modules provide documentation, see @subpage user_doc for more information. Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more advanced building strategies and development notes. ## Test Framework There is PyDoc generated documentation available for the VPP test framework. See @subpage test_framework_doc for details.


context:
space:
mode: