From patchwork Tue Aug 13 11:25:39 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dekel Peled X-Patchwork-Id: 57654 X-Patchwork-Delegate: rasland@nvidia.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 0516A1B94A; Tue, 13 Aug 2019 13:26:20 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by dpdk.org (Postfix) with ESMTP id 29A515681 for ; Tue, 13 Aug 2019 13:26:18 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE1 (envelope-from dekelp@mellanox.com) with ESMTPS (AES256-SHA encrypted); 13 Aug 2019 14:26:14 +0300 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 x7DBQE2q028507; Tue, 13 Aug 2019 14:26:14 +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, dev@dpdk.org, stable@dpdk.org Date: Tue, 13 Aug 2019 14:25:39 +0300 Message-Id: <86cab83a7628da576933f5f6267abe600b2ae604.1565695422.git.dekelp@mellanox.com> X-Mailer: git-send-email 1.7.1 Subject: [dpdk-dev] [PATCH] doc: fix description of links to EAL options pages X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 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..1b19cd1 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:`../linux_gsg/linux_eal_parameters` (Linux) or +:doc:`../freebsd_gsg/freebsd_eal_parameters` (FreeBSD) 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 d0d89b3..8b5d823 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:`../linux_gsg/linux_eal_parameters` (Linux) or +:doc:`../freebsd_gsg/freebsd_eal_parameters` (FreeBSD) for a list of available +EAL command-line options. Testpmd Command-line Options