DPDK patches and discussions
 help / color / mirror / Atom feed
From: Rami Rosen <roszenrami@gmail.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>
Cc: "Burakov, Anatoly" <anatoly.burakov@intel.com>,
	dev@dpdk.org, john.mcnamara@intel.com,
	 marko.kovacevic@intel.com, bruce.richardson@intel.com,
	wenzhuo.lu@intel.com,  jingjing.wu@intel.com,
	bernard.iremonger@intel.com, thomas@monjalon.net,
	 keith.wiles@intel.com
Subject: Re: [dpdk-dev] [PATCH] doc: document all EAL parameters in one place
Date: Sat, 17 Nov 2018 07:15:01 +0200	[thread overview]
Message-ID: <CAKoUArmVrSPjnhZpmLFMQf5kNWAG2Q01J8W34UxH_t_TxLB_uA@mail.gmail.com> (raw)
In-Reply-To: <94a86ddc-1940-7100-b543-e36bbdb3dbc5@intel.com>

On 11/16/2018 4:52 PM, Anatoly Burakov wrote:
> Currently, the most complete (but still incomplete) user guide for
> EAL command-line parameters resides in user guide for testpmd.
> This is wrong on multiple levels, and should not be the case.
>
> To fix it, we have to create a document that lists all supported
> EAL command-line arguments. However, because different platforms
> support different subsets of available EAL parameters, instead of
> creating a single file, we will create a common file in
> doc/guides/common containing documentation for EAL parameters
> that are supported on all of our supported platforms (Linux and
> FreeBSD at the time of this writing).
>
> We will then include this document in the Getting Started guides
> for all supported platforms, so that any changes made to
> documentation for commonly supported EAL parameters will be
> reflected in Getting Started guides for all platforms.
>
> This patch also removes EAL parameters documentation from the
> testpmd user guide, and instead adds references to the newly
> created documents in both testpmd user guides and in sample
> applications guide.
>
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>

This is a right and needed thing to do, thanks!

Reviewed-by: Rami Rosen <roszenrami at gmail.com>

  reply	other threads:[~2018-11-17  5:15 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-16 16:52 Anatoly Burakov
2018-11-16 17:25 ` Ferruh Yigit
2018-11-17  5:15   ` Rami Rosen [this message]
2018-11-19 11:07     ` Mcnamara, John
2018-11-19 10:15 ` Burakov, Anatoly
2018-11-19 13:10 ` [dpdk-dev] [PATCH v2] " Anatoly Burakov
2018-11-19 13:14   ` Burakov, Anatoly
2018-11-22 17:27   ` Thomas Monjalon
2018-11-23  9:20     ` Burakov, Anatoly
2018-11-23  9:54       ` Thomas Monjalon
2018-11-23 10:51   ` Thomas Monjalon

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=CAKoUArmVrSPjnhZpmLFMQf5kNWAG2Q01J8W34UxH_t_TxLB_uA@mail.gmail.com \
    --to=roszenrami@gmail.com \
    --cc=anatoly.burakov@intel.com \
    --cc=bernard.iremonger@intel.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=jingjing.wu@intel.com \
    --cc=john.mcnamara@intel.com \
    --cc=keith.wiles@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=thomas@monjalon.net \
    --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).