Skip to content

Commit

Permalink
doc: fix description of links to EAL options pages
Browse files Browse the repository at this point in the history
[ upstream commit c41c100 ]

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: 3ee567c ("doc: document all EAL parameters in one place")

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
  • Loading branch information
dekelp authored and kevintraynor committed Dec 10, 2019
1 parent 66742b2 commit a6aa809
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions doc/guides/sample_app_ug/intro.rst
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions doc/guides/testpmd_app_ug/run_app.rst
Expand Up @@ -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
Expand Down

0 comments on commit a6aa809

Please sign in to comment.