From c41c100b2278ed4d56fc548697c90e103cc523e2 Mon Sep 17 00:00:00 2001 From: Dekel Peled Date: Thu, 24 Oct 2019 16:17:51 +0300 Subject: [PATCH] doc: fix description of links to EAL options pages 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 6a3b6722e0..0b4ab1ba41 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 ef677ba2f8..00e0c2ac51 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 -- 2.20.1