From mboxrd@z Thu Jan 1 00:00:00 1970 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) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 19 Nov 2018 05:14:35 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,252,1539673200"; d="scan'208";a="93204242" Received: from aburakov-mobl1.ger.corp.intel.com (HELO [10.237.220.124]) ([10.237.220.124]) by orsmga008.jf.intel.com with ESMTP; 19 Nov 2018 05:14:32 -0800 To: dev@dpdk.org Cc: Bruce Richardson , John McNamara , Marko Kovacevic , Wenzhuo Lu , Jingjing Wu , Bernard Iremonger , thomas@monjalon.net, ferruh.yigit@intel.com, keith.wiles@intel.com References: <6c5eddbb2339d917a9b67666499ae11ca8aa344b.1542386956.git.anatoly.burakov@intel.com> From: "Burakov, Anatoly" Message-ID: Date: Mon, 19 Nov 2018 13:14:32 +0000 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [dpdk-dev] [PATCH v2] doc: document all EAL parameters in one place X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 19 Nov 2018 13:14:37 -0000 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