From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id D78E7A32A2 for ; Thu, 24 Oct 2019 15:21:17 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A33731EA95; Thu, 24 Oct 2019 15:21:17 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by dpdk.org (Postfix) with ESMTP id 5E38E1EA7E for ; Thu, 24 Oct 2019 15:21:13 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE1 (envelope-from dekelp@mellanox.com) with ESMTPS (AES256-SHA encrypted); 24 Oct 2019 15:21:09 +0200 Received: from mtl-vdi-280.wap.labs.mlnx. (mtl-vdi-280.wap.labs.mlnx [10.128.130.87]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x9ODL9h0017775; Thu, 24 Oct 2019 16:21:09 +0300 From: Dekel Peled To: wenzhuo.lu@intel.com, jingjing.wu@intel.com, bernard.iremonger@intel.com, john.mcnamara@intel.com, marko.kovacevic@intel.com Cc: anatoly.burakov@intel.com, david.marchand@redhat.com, dev@dpdk.org, stable@dpdk.org Date: Thu, 24 Oct 2019 16:17:51 +0300 Message-Id: <4308fbb8624fcea14f2f7af52800c05d199a2eb9.1571922630.git.dekelp@mellanox.com> X-Mailer: git-send-email 1.7.1 In-Reply-To: <86cab83a7628da576933f5f6267abe600b2ae604.1565695422.git.dekelp@mellanox.com> References: <86cab83a7628da576933f5f6267abe600b2ae604.1565695422.git.dekelp@mellanox.com> Subject: [dpdk-stable] [PATCH v2] doc: fix description of links to EAL options pages X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" Documentation includes separate pages of EAL command-line options for Linux and for FreeBSD. Links to these pages use the same text 'EAL parameters', so it is not clear which link to use for which environment. This patch adds the text '(Linux)' and '(FreeBSD)' where relevant, to clearly identify the links. Fixes: 3ee567cfec37 ("doc: document all EAL parameters in one place") Cc: stable@dpdk.org --- v2: update links names for clarity. --- Signed-off-by: Dekel Peled Acked-by: Anatoly Burakov --- doc/guides/sample_app_ug/intro.rst | 6 +++--- doc/guides/testpmd_app_ug/run_app.rst | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst index 9070419..71d99f9 100644 --- a/doc/guides/sample_app_ug/intro.rst +++ b/doc/guides/sample_app_ug/intro.rst @@ -15,9 +15,9 @@ Running Sample Applications Some sample applications may have their own command-line parameters described in their respective guides, however all of them also share the same EAL parameters. -Please refer to :doc:`../linux_gsg/linux_eal_parameters` or -:doc:`../freebsd_gsg/freebsd_eal_parameters` for a list of available EAL -command-line options. +Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>` +or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for +a list of available EAL command-line options. The DPDK Sample Applications diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst index ef677ba..00e0c2a 100644 --- a/doc/guides/testpmd_app_ug/run_app.rst +++ b/doc/guides/testpmd_app_ug/run_app.rst @@ -7,9 +7,9 @@ Running the Application EAL Command-line Options ------------------------ -Please refer to :doc:`../linux_gsg/linux_eal_parameters` or -:doc:`../freebsd_gsg/freebsd_eal_parameters` for a list of available EAL -command-line options. +Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>` +or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for +a list of available EAL command-line options. Testpmd Command-line Options -- 1.8.3.1