Thanks David, please see my comments below.
> -----Original Message-----
> From: David Marchand <david.march...@redhat.com>
> Sent: Tuesday, October 8, 2019 1:05 PM
> To: Dekel Peled <dek...@mellanox.com>
> Cc: Wenzhuo Lu <wenzhuo...@intel.com>; Jingjing Wu
> <jingjing...@intel.com>; Iremonger, Bernard
> <bernard.iremon...@intel.com>; Mcnamara, John
> <john.mcnam...@intel.com>; Kovacevic, Marko
> <marko.kovace...@intel.com>; Burakov, Anatoly
> <anatoly.bura...@intel.com>; dev <dev@dpdk.org>; dpdk stable
> <sta...@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 <dek...@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: sta...@dpdk.org
> >
> > Signed-off-by: Dekel Peled <dek...@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
