doc: fix description of links to EAL options pages
diff mbox series

Message ID 86cab83a7628da576933f5f6267abe600b2ae604.1565695422.git.dekelp@mellanox.com
State Superseded
Delegated to: Raslan Darawsheh
Headers show
Series
  • doc: fix description of links to EAL options pages
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Dekel Peled Aug. 13, 2019, 11:25 a.m. UTC
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(-)

Comments

Burakov, Anatoly Aug. 13, 2019, 1:30 p.m. UTC | #1
On 13-Aug-19 12:25 PM, Dekel Peled wrote:
> 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>
> ---

Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
David Marchand Oct. 8, 2019, 10:05 a.m. UTC | #2
Nit: this patch title does not reflect what the issue was.
Hard to tell when just looking at it what the impact of your patch is.


On Tue, Aug 13, 2019 at 1:26 PM Dekel Peled <dekelp@mellanox.com> wrote:
>
> 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.

Adding this text after the link itself is odd: in the resulting
documentation, we still have two links named the same.

How about renaming the links?
Something like:

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.


Thanks.
Dekel Peled Oct. 22, 2019, 11:30 a.m. UTC | #3
Thanks David, please see my comments below.

> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Tuesday, October 8, 2019 1:05 PM
> To: Dekel Peled <dekelp@mellanox.com>
> Cc: Wenzhuo Lu <wenzhuo.lu@intel.com>; Jingjing Wu
> <jingjing.wu@intel.com>; Iremonger, Bernard
> <bernard.iremonger@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; Burakov, Anatoly
> <anatoly.burakov@intel.com>; dev <dev@dpdk.org>; dpdk stable
> <stable@dpdk.org>
> Subject: Re: [dpdk-stable] [PATCH] doc: fix description of links to EAL options
> pages
> 
> Nit: this patch title does not reflect what the issue was.
> Hard to tell when just looking at it what the impact of your patch is.

This is the best description I could think of that fits in the 50 characters limit.
Any suggestions are welcome.

> 
> 
> On Tue, Aug 13, 2019 at 1:26 PM Dekel Peled <dekelp@mellanox.com>
> wrote:
> >
> > 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.
> 
> Adding this text after the link itself is odd: in the resulting documentation, we
> still have two links named the same.
> 
> How about renaming the links?
> Something like:
> 
> 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.

Agree, will send v2 with this change.

> 
> 
> Thanks.
> 
> --
> David Marchand

Patch
diff mbox series

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