From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from compass.polito.it (compass.polito.it [130.192.55.110]) by dpdk.org (Postfix) with ESMTP id 883F92BD0 for ; Thu, 25 Feb 2016 18:02:52 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by compass.polito.it (Postfix) with ESMTP id 6C3C6100110; Thu, 25 Feb 2016 18:02:52 +0100 (CET) Authentication-Results: compass.polito.it (amavisd-new); dkim=pass (1024-bit key) reason="pass (just generated, assumed good)" header.d=studenti.polito.it DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d= studenti.polito.it; h=references:in-reply-to:x-mailer:message-id :date:date:subject:subject:cc:to:from:from:received:received; s= y2k10; t=1456419771; bh=aBTXGqgBXLBz1WX6Q6voMGhiyJYK7zQqu0WEbIrD BI0=; b=ndGhs5MqxhJR6FuD336IhDVM8kbTkaUVDVjaHkX3NAN8AranwGOKPIDk DwnmbWfQsFftKYrW6R5foqsrYZjAOcOc0o6VznOR5ZSn0ZBaBnYSFyRoU322OV4G KOeKai3sg6UB+SQTdWi7Q9vEcagmCm5rtOuUK+1rR/8pe68ZVFo= X-Virus-Scanned: amavisd-new at studenti.polito.it X-Spam-Flag: NO X-Spam-Score: -6.475 X-Spam-Level: X-Spam-Status: No, score=-6.475 tagged_above=-100 required=3.5 tests=[ALL_TRUSTED=-5, AWL=0.025, BAYES_00=-1.5] autolearn=ham Received: from compass.polito.it ([127.0.0.1]) by localhost (compass.polito.it [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id t0urzekrivdr; Thu, 25 Feb 2016 18:02:51 +0100 (CET) Received: from localhost.localdomain (unknown [130.192.225.153]) (using TLSv1.2 with cipher AES128-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: s203403@studenti.polito.it) by compass.polito.it (Postfix) with ESMTPSA id 7CEB9100117; Thu, 25 Feb 2016 18:02:50 +0100 (CET) From: Mauricio Vasquez B To: john.mcnamara@intel.com Date: Thu, 25 Feb 2016 18:02:40 +0100 Message-Id: <1456419765-8566-15-git-send-email-mauricio.vasquezbernal@studenti.polito.it> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1456419765-8566-1-git-send-email-mauricio.vasquezbernal@studenti.polito.it> References: <1456419765-8566-1-git-send-email-mauricio.vasquezbernal@studenti.polito.it> Cc: dev@dpdk.org Subject: [dpdk-dev] [PATCH 14/19] doc: fix l3fwd virtual sample app hard-coded references X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 25 Feb 2016 17:02:53 -0000 Signed-off-by: Mauricio Vasquez B --- 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