summaryrefslogtreecommitdiff
path: root/doc/guides/sample_app_ug/l3_forward_access_ctrl.rst
AgeCommit message (Collapse)Author
2018-02-06doc: convert Intel license headers to SPDX tagsFerruh Yigit
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2017-10-27doc: add generic build instructions for sample appsHerakliusz Lipiec
Moved duplicated, and occasionally outdated, doc sections from each of the sample app guides chapters to a common chapter at the start. This reduces the duplication in the docs and provides a single point of reference for compiling the sample apps. Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec@intel.com> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
2017-03-01doc: use corelist instead of coremaskKeith Wiles
The coremask option in DPDK is difficult to use and we should be promoting the use of the corelist (-l) option. The patch adjusts the docs to use -l EAL option instead of the -c option. The patch only changes the docs and not the code as the -c option will continue to exist unless it is removed in the future. The -c option should be kept to maintain backward compatibility. Signed-off-by: Keith Wiles <keith.wiles@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2017-01-17doc: simplify l3fwd example guidePablo de Lara
L3 Forwarding sample app user guides have some inconsistencies between the example command line and the configuration table. Also, they were showing too complicated configuration, using two different NUMA nodes for two ports, which will probably lead to performance drop due to use cross-socket channel. This patch simplifies the configuration of these examples, by using a single NUMA node and a single queue per port. Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
2016-03-07doc: fix references in sample apps guideMauricio Vasquez B
MANY references in the sample applications user guide are wrong because they are hard-coded and section numbers have changed over the time. This patch changes thoses references to dynamic ones, in this way if section numbers change the reference get updated automatically. Signed-off-by: Mauricio Vasquez B <mauricio.vasquezbernal@studenti.polito.it>
2015-05-25doc: refactor figure numbers into referencesJohn McNamara
This change adds automatic figure references to the docs. The figure numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. The patch makes the following changes. * Changes image:: tag to figure:: and moves image caption to the figure. * Adds captions to figures that didn't previously have any. * Un-templates the |image-name| substitution definitions into explicit figure:: tags. They weren't used more than once anyway and Sphinx doesn't support them for figure. * Adds a target to each image that didn't previously have one so that they can be cross-referenced. * Renamed existing image target to match the image name for consistency. * Replaces the Figures lists with automatic :numref: :ref: entries to generate automatic numbering and captions. * Replaces "Figure" references with automatic :numref: references. Signed-off-by: John McNamara <john.mcnamara@intel.com>
2015-03-19doc: convert image extensions to wildcardJohn McNamara
Changed all image.svg and image.png extensions to image.* This allows Sphinx to decide the appropriate image type from the available image options. In case of PDF, SVG images are converted and Sphinx must pick the converted version. Signed-off-by: John McNamara <john.mcnamara@intel.com> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-12-19doc: remove Intel references from sample apps guideSiobhan Butler
Removed redundant references to Intel(R) DPDK in Sample App UG. Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
2014-11-13doc: sample application user guideBernard Iremonger
The 1.7 DPDK_SampleApp_UG document in MSWord has been converted to rst format for use with Sphinx. There is an rst file for each chapter and an index.rst file which contains the table of contents. The top level index file has been modified to include this guide. This document contains some png image files. If any of thes png files are modified they should be replaced with an svg file. This is the fifth document from a set of 6 documents. Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>