patches for DPDK stable branches
 help / color / Atom feed
* [dpdk-stable] [PATCH] doc: fix description of links to EAL options pages
@ 2019-08-13 11:25 Dekel Peled
  2019-08-13 13:30 ` Burakov, Anatoly
                   ` (2 more replies)
  0 siblings, 3 replies; 6+ messages in thread
From: Dekel Peled @ 2019-08-13 11:25 UTC (permalink / raw)
  To: wenzhuo.lu, jingjing.wu, bernard.iremonger, john.mcnamara,
	marko.kovacevic
  Cc: anatoly.burakov, dev, 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

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
---
 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
-- 
1.8.3.1


^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, back to index

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-08-13 11:25 [dpdk-stable] [PATCH] doc: fix description of links to EAL options pages Dekel Peled
2019-08-13 13:30 ` Burakov, Anatoly
2019-10-08 10:05 ` David Marchand
2019-10-22 11:30   ` Dekel Peled
2019-10-24 13:17 ` [dpdk-stable] [PATCH v2] " Dekel Peled
2019-10-30 10:28   ` David Marchand

patches for DPDK stable branches

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/stable/0 stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ http://inbox.dpdk.org/stable \
		stable@dpdk.org
	public-inbox-index stable


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.stable


AGPL code for this site: git clone https://public-inbox.org/ public-inbox