DPDK patches and discussions
 help / color / mirror / Atom feed
From: David Marchand <david.marchand@redhat.com>
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-dev] [PATCH v2] doc: fix description of links to EAL options pages
Date: Wed, 30 Oct 2019 11:28:47 +0100	[thread overview]
Message-ID: <CAJFAV8xmdZVqinSJ2ALO1cj-0LTBsR2S4jUe9xjj-0qAf+Vrdg@mail.gmail.com> (raw)
In-Reply-To: <4308fbb8624fcea14f2f7af52800c05d199a2eb9.1571922630.git.dekelp@mellanox.com>

On Thu, Oct 24, 2019 at 3:21 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
>
> ---
> v2: update links names for clarity.
> ---

Please, annotations must come after your commitlog.
The SoB and Ack are part of a commitlog, but here we lose them.

Fixed when applying.


> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> Acked-by: Anatoly Burakov <anatoly.burakov@intel.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..71d99f9 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:`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
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
> index ef677ba..00e0c2a 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:`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
> --
> 1.8.3.1
>

No better idea for the title, so going with yours.
Applied, thanks.


--
David Marchand


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

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

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=CAJFAV8xmdZVqinSJ2ALO1cj-0LTBsR2S4jUe9xjj-0qAf+Vrdg@mail.gmail.com \
    --to=david.marchand@redhat.com \
    --cc=anatoly.burakov@intel.com \
    --cc=bernard.iremonger@intel.com \
    --cc=dekelp@mellanox.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).