From mboxrd@z Thu Jan  1 00:00:00 1970
From: Ferruh Yigit <ferruh.yigit@intel.com>
Subject: Re: [PATCH] doc: document all EAL parameters in one place
Date: Fri, 16 Nov 2018 17:25:52 +0000
Message-ID: <94a86ddc-1940-7100-b543-e36bbdb3dbc5@intel.com>
References: <6c5eddbb2339d917a9b67666499ae11ca8aa344b.1542386956.git.anatoly.burakov@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Cc: John McNamara <john.mcnamara@intel.com>,
 Marko Kovacevic <marko.kovacevic@intel.com>,
 Bruce Richardson <bruce.richardson@intel.com>,
 Wenzhuo Lu <wenzhuo.lu@intel.com>, Jingjing Wu <jingjing.wu@intel.com>,
 Bernard Iremonger <bernard.iremonger@intel.com>, thomas@monjalon.net,
 keith.wiles@intel.com
To: Anatoly Burakov <anatoly.burakov@intel.com>, dev@dpdk.org
Return-path: <dev-bounces@dpdk.org>
Received: from mga17.intel.com (mga17.intel.com [192.55.52.151])
 by dpdk.org (Postfix) with ESMTP id 070502BD8
 for <dev@dpdk.org>; Fri, 16 Nov 2018 18:26:00 +0100 (CET)
In-Reply-To: <6c5eddbb2339d917a9b67666499ae11ca8aa344b.1542386956.git.anatoly.burakov@intel.com>
Content-Language: en-US
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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>

+1

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>