patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Dekel Peled <dekelp@mellanox.com>
To: David Marchand <david.marchand@redhat.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
Date: Tue, 22 Oct 2019 11:30:55 +0000	[thread overview]
Message-ID: <AM4PR05MB346033DA766D1C63893CCE6EB6680@AM4PR05MB3460.eurprd05.prod.outlook.com> (raw)
In-Reply-To: <CAJFAV8yftT4X4vyJe=avDEp_VdSNUjz7JQz0Doz0z=hx88KC4A@mail.gmail.com>

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


  reply	other threads:[~2019-10-22 11:30 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-13 11:25 Dekel Peled
2019-08-13 13:30 ` Burakov, Anatoly
2019-10-08 10:05 ` David Marchand
2019-10-22 11:30   ` Dekel Peled [this message]
2019-10-24 13:17 ` [dpdk-stable] [PATCH v2] " Dekel Peled
2019-10-30 10:28   ` David Marchand

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=AM4PR05MB346033DA766D1C63893CCE6EB6680@AM4PR05MB3460.eurprd05.prod.outlook.com \
    --to=dekelp@mellanox.com \
    --cc=anatoly.burakov@intel.com \
    --cc=bernard.iremonger@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=jingjing.wu@intel.com \
    --cc=john.mcnamara@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=stable@dpdk.org \
    --cc=wenzhuo.lu@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).