From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 2AA672C0C for ; Wed, 3 Aug 2016 16:32:42 +0200 (CEST) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga102.jf.intel.com with ESMTP; 03 Aug 2016 07:32:30 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.28,465,1464678000"; d="scan'208";a="1018966947" Received: from bricha3-mobl3.ger.corp.intel.com ([10.237.221.36]) by fmsmga001.fm.intel.com with SMTP; 03 Aug 2016 07:32:23 -0700 Received: by (sSMTP sendmail emulation); Wed, 03 Aug 2016 15:32:22 +0025 Date: Wed, 3 Aug 2016 15:32:22 +0100 From: Bruce Richardson To: Thomas Monjalon Cc: John McNamara , dev@dpdk.org Message-ID: <20160803143222.GA13564@bricha3-MOBL3> References: <1467309817-11739-1-git-send-email-john.mcnamara@intel.com> <1469793554-1013-1-git-send-email-john.mcnamara@intel.com> <3844504.Omypy6q39V@xps13> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <3844504.Omypy6q39V@xps13> Organization: Intel Research and =?iso-8859-1?Q?De=ACvel?= =?iso-8859-1?Q?opment?= Ireland Ltd. User-Agent: Mutt/1.5.23 (2014-03-12) Subject: Re: [dpdk-dev] [PATCH v3] doc: autogenerate nic overview table from ini files X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 03 Aug 2016 14:32:42 -0000 On Mon, Aug 01, 2016 at 11:37:03PM +0200, Thomas Monjalon wrote: > Hi John, > > 2016-07-29 12:59, John McNamara: > > Convert the NIC feature table in the overview doc into a set of ini > > files and add functions into the Sphinx conf.py file to auto-generate > > them back into an RST table. > > I have not reviewed the Python code which generate the RST table. > It works so it could be applied as is. > > > The reason for doing this is to make it easier for PMD maintainers to > > update the feature matrix that makes up the table and to avoid > > frequent and hard to resolve conflicts in doc/guides/nics/overview.rst. > > Yes thanks for the work. > > My main concern before applying this patch, is the name of the files: > > > doc/guides/nics/nic_features/fm10k.ini | 34 ++++++ > > doc/guides/nics/nic_features/fm10k_vec.ini | 34 ++++++ > > doc/guides/nics/nic_features/fm10k_vf.ini | 28 +++++ > > doc/guides/nics/nic_features/fm10kvf_vec.ini | 28 +++++ > > doc/guides/nics/nic_features/i40e.ini | 47 ++++++++ > > doc/guides/nics/nic_features/i40e_vec.ini | 39 +++++++ > > doc/guides/nics/nic_features/i40e_vf.ini | 36 +++++++ > > doc/guides/nics/nic_features/i40evf_vec.ini | 28 +++++ > > doc/guides/nics/nic_features/igb.ini | 44 ++++++++ > > doc/guides/nics/nic_features/igb_vf.ini | 27 +++++ > > doc/guides/nics/nic_features/ixgbe.ini | 54 ++++++++++ > > doc/guides/nics/nic_features/ixgbe_vec.ini | 46 ++++++++ > > doc/guides/nics/nic_features/ixgbe_vf.ini | 37 +++++++ > > doc/guides/nics/nic_features/ixgbevf_vec.ini | 29 +++++ > > It would be more consistent to always put an underscore before vf. > > About the directory, I suggest doc/guides/nics/features/. > > Other small nit: there is a typo in every files: availble -> available. > > It would be nice to start the 16.11 cycle with this change and make sure we > won't change the filenames later in the cycle. So we can start sending > some patches without risking a conflict. > Thanks Those changes you propose seem reasonable to me. Having this table as ini files will be a big help in reducing merge conflicts! /Bruce