From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH v2] doc: document all EAL parameters in one place Date: Fri, 23 Nov 2018 11:51:04 +0100 Message-ID: <1593769.unVIRhr16N@xps> References: <6c5eddbb2339d917a9b67666499ae11ca8aa344b.1542386956.git.anatoly.burakov@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: dev@dpdk.org, Bruce Richardson , John McNamara , Marko Kovacevic , Wenzhuo Lu , Jingjing Wu , Bernard Iremonger , ferruh.yigit@intel.com, keith.wiles@intel.com To: Anatoly Burakov Return-path: Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id C44A11B0F8 for ; Fri, 23 Nov 2018 11:51:08 +0100 (CET) In-Reply-To: List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 19/11/2018 14:10, Anatoly Burakov: > 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 > Acked-by: Ferruh Yigit > Reviewed-by: Rami Rosen Applied with typo fixed, thanks