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 08A972BDB for ; Thu, 25 Feb 2016 18:02:56 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by compass.polito.it (Postfix) with ESMTP id DD45A100109; Thu, 25 Feb 2016 18:02:55 +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=1456419772; bh=rIOjVXJa/23AlOCuqaEhaoFjL0lmdcAL5XuhhQaG ltI=; b=LdAIBo9vN98Juf/uk1V/meLgFC3GWK42TurTgqYaz0iNgxj21iDowhVz MFwkxYzNceyQE9y8GldqzVCcsvuDvHyWPkdWKPwcM8WemRnG2dYYgxpo5u2AR4gi t+4IOObGsz+EAQ0vdS4nt0WYza6fPXMB3sLEeWvasiGgYflvgaI= X-Virus-Scanned: amavisd-new at studenti.polito.it X-Spam-Flag: NO X-Spam-Score: -6.478 X-Spam-Level: X-Spam-Status: No, score=-6.478 tagged_above=-100 required=3.5 tests=[ALL_TRUSTED=-5, AWL=0.022, 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 DYhL8VYBwKH6; Thu, 25 Feb 2016 18:02:52 +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 9D4321000F8; 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:43 +0100 Message-Id: <1456419765-8566-18-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 17/19] doc: fix tep termination 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:56 -0000 Signed-off-by: Mauricio Vasquez B --- doc/guides/sample_app_ug/tep_termination.rst | 8 ++++---- doc/guides/sample_app_ug/vhost.rst | 7 +++++++ 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/guides/sample_app_ug/tep_termination.rst b/doc/guides/sample_app_ug/tep_termination.rst index 71a4acd..2d86a03 100644 --- a/doc/guides/sample_app_ug/tep_termination.rst +++ b/doc/guides/sample_app_ug/tep_termination.rst @@ -121,7 +121,7 @@ The example in this section have been validated with the following distributions Prerequisites ------------- -Refer to the guide in section 27.4 in the vhost sample. +Refer to :ref:`vhost_app_prerequisites`. Compiling the Sample Code ------------------------- @@ -225,7 +225,7 @@ Parameters **The same parameters with the vhost sample.** -Refer to the guide in section 27.6.1 in the vhost sample for the meanings of 'Basename', +Refer to :ref:`vhost_app_parameters` for the meanings of 'Basename', 'Stats', 'RX Retry', 'RX Retry Number' and 'RX Retry Delay Time'. **Number of Devices.** @@ -303,12 +303,12 @@ The default value is 1. Running the Virtual Machine (QEMU) ---------------------------------- -Refer to the guide in section 27.7 in the vhost sample. +Refer to :ref:`vhost_app_running`. Running DPDK in the Virtual Machine ----------------------------------- -Refer to the guide in section 27.8 in the vHost sample. +Refer to :ref:`vhost_app_running_dpdk`. Passing Traffic to the Virtual Machine Device --------------------------------------------- diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst index 751656c..47ce36c 100644 --- a/doc/guides/sample_app_ug/vhost.rst +++ b/doc/guides/sample_app_ug/vhost.rst @@ -144,6 +144,8 @@ The example in this section have been validated with the following distributions * Fedora* 20 +.. _vhost_app_prerequisites: + Prerequisites ------------- @@ -405,6 +407,8 @@ Running the Sample Code The number used with the --socket-mem parameter may need to be more than 1024. The number required depends on the number of mbufs allocated by vhost-switch. +.. _vhost_app_parameters: + Parameters ~~~~~~~~~~ @@ -530,6 +534,8 @@ It is enabled by default. ./vhost-switch -c f -n 4 --socket-mem 1024 --huge-dir /mnt/huge \ -- --vlan-strip [0, 1] +.. _vhost_app_running: + Running the Virtual Machine (QEMU) ---------------------------------- @@ -760,6 +766,7 @@ Common Issues Linux module but which is necessary for the user space VHOST current implementation (CUSE-based) to communicate with the guest. +.. _vhost_app_running_dpdk: Running DPDK in the Virtual Machine ----------------------------------- -- 1.9.1