[dpdk-dev] [PATCH 14/19] doc: fix l3fwd virtual sample app hard-coded references

Mauricio Vasquez B mauricio.vasquezbernal at studenti.polito.it
Thu Feb 25 18:02:40 CET 2016


Signed-off-by: Mauricio Vasquez B <mauricio.vasquezbernal at studenti.polito.it>
---
 doc/guides/sample_app_ug/l2_forward_real_virtual.rst | 1 +
 doc/guides/sample_app_ug/l3_forward.rst              | 2 ++
 doc/guides/sample_app_ug/l3_forward_virtual.rst      | 7 +++----
 3 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
index 2a576f3..e77d67c 100644
--- a/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
+++ b/doc/guides/sample_app_ug/l2_forward_real_virtual.rst
@@ -75,6 +75,7 @@ The L2 Forwarding application can also be used as a starting point for developin
 
    Performance Benchmark Setup (Virtualized Environment)
 
+.. _l2_fwd_vf_setup:
 
 Virtual Function Setup Instructions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst
index 1aac7dd..1522650 100644
--- a/doc/guides/sample_app_ug/l3_forward.rst
+++ b/doc/guides/sample_app_ug/l3_forward.rst
@@ -156,6 +156,8 @@ In this command:
 Refer to the *DPDK Getting Started Guide* for general information on running applications and
 the Environment Abstraction Layer (EAL) options.
 
+.. _l3_fwd_explanation:
+
 Explanation
 -----------
 
diff --git a/doc/guides/sample_app_ug/l3_forward_virtual.rst b/doc/guides/sample_app_ug/l3_forward_virtual.rst
index f40643a..fa04722 100644
--- a/doc/guides/sample_app_ug/l3_forward_virtual.rst
+++ b/doc/guides/sample_app_ug/l3_forward_virtual.rst
@@ -39,8 +39,7 @@ Overview
 --------
 
 The application demonstrates the use of the hash and LPM libraries in the DPDK to implement packet forwarding.
-The initialization and run-time paths are very similar to those of the L3 forwarding application
-(see Chapter 10 "L3 Forwarding Sample Application" for more information).
+The initialization and run-time paths are very similar to those of the :doc:`l3_forward`.
 The forwarding decision is taken based on information read from the input packet.
 
 The lookup method is either hash-based or LPM-based and is selected at compile time.
@@ -60,7 +59,7 @@ The set of LPM rules used by the application is statically configured and loaded
 
 .. note::
 
-    Please refer to Section 9.1.1 "Virtual Function Setup Instructions" for virtualized test case setup.
+    Please refer to :ref:`l2_fwd_vf_setup` for virtualized test case setup.
 
 Compiling the Application
 -------------------------
@@ -155,4 +154,4 @@ Explanation
 -----------
 
 The operation of this application is similar to that of the basic L3 Forwarding Sample Application.
-See Section 10.4 "Explanation" for more information.
+See :ref:`l3_fwd_explanation` for more information.
-- 
1.9.1



More information about the dev mailing list