From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Burakov, Anatoly" Subject: Re: [PATCH v2] doc: document all EAL parameters in one place Date: Mon, 19 Nov 2018 13:14:32 +0000 Message-ID: References: <6c5eddbb2339d917a9b67666499ae11ca8aa344b.1542386956.git.anatoly.burakov@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Cc: Bruce Richardson , John McNamara , Marko Kovacevic , Wenzhuo Lu , Jingjing Wu , Bernard Iremonger , thomas@monjalon.net, ferruh.yigit@intel.com, keith.wiles@intel.com To: dev@dpdk.org Return-path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 975AE2B9E for ; Mon, 19 Nov 2018 14:14:36 +0100 (CET) In-Reply-To: Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On 19-Nov-18 1:10 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 Oops, forgot to fix commit message. Should be "doc/guides/linux_gsg", not "doc/guides/common". > 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 > Acked-by: Ferruh Yigit > Reviewed-by: Rami Rosen > --- -- Thanks, Anatoly