summaryrefslogtreecommitdiff
path: root/doc/guides/sample_app_ug/l2_forward_cat.rst
diff options
context:
space:
mode:
authorHerakliusz Lipiec <herakliusz.lipiec@intel.com>2017-10-25 16:50:59 +0100
committerThomas Monjalon <thomas@monjalon.net>2017-10-27 01:23:53 +0200
commit7cacb05655397c0c50bcba89eb836d417bc78b69 (patch)
treefa2bad0cc78017c7e3baa037a902dc797f89f6e5 /doc/guides/sample_app_ug/l2_forward_cat.rst
parent0acd8ed3330a629658e3864d78a6bd4b78de321e (diff)
downloaddpdk-7cacb05655397c0c50bcba89eb836d417bc78b69.zip
dpdk-7cacb05655397c0c50bcba89eb836d417bc78b69.tar.gz
dpdk-7cacb05655397c0c50bcba89eb836d417bc78b69.tar.xz
doc: add generic build instructions for sample apps
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>
Diffstat (limited to 'doc/guides/sample_app_ug/l2_forward_cat.rst')
-rw-r--r--doc/guides/sample_app_ug/l2_forward_cat.rst34
1 files changed, 12 insertions, 22 deletions
diff --git a/doc/guides/sample_app_ug/l2_forward_cat.rst b/doc/guides/sample_app_ug/l2_forward_cat.rst
index b0c2e10..a10f23a 100644
--- a/doc/guides/sample_app_ug/l2_forward_cat.rst
+++ b/doc/guides/sample_app_ug/l2_forward_cat.rst
@@ -67,38 +67,28 @@ White paper demonstrating example use case:
Compiling the Application
-------------------------
+.. note::
-Requires ``libpqos`` from Intel's
-`intel-cmt-cat software package <https://github.com/01org/intel-cmt-cat>`_
-hosted on GitHub repository. For installation notes, please see ``README`` file.
+ Requires ``libpqos`` from Intel's
+ `intel-cmt-cat software package <https://github.com/01org/intel-cmt-cat>`_
+ hosted on GitHub repository. For installation notes, please see ``README`` file.
-GIT:
+ GIT:
-* https://github.com/01org/intel-cmt-cat
-
-To compile the application export the path to PQoS lib
-and the DPDK source tree and go to the example directory:
-
-.. code-block:: console
+ * https://github.com/01org/intel-cmt-cat
- export PQOS_INSTALL_PATH=/path/to/libpqos
- export RTE_SDK=/path/to/rte_sdk
- cd ${RTE_SDK}/examples/l2fwd-cat
+#. To compile the application export the path to PQoS lib
+ and the DPDK source tree and go to the example directory:
-Set the target, for example:
+ .. code-block:: console
-.. code-block:: console
-
- export RTE_TARGET=x86_64-native-linuxapp-gcc
+ export PQOS_INSTALL_PATH=/path/to/libpqos
-See the *DPDK Getting Started* Guide for possible ``RTE_TARGET`` values.
-Build the application as follows:
-
-.. code-block:: console
+To compile the sample application see :doc:`compiling`.
- make
+The application is located in the ``l2fwd-cat`` sub-directory.
Running the Application