From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas.monjalon@6wind.com>
Subject: Re: [PATCH v3] doc: autogenerate nic overview table from
	ini files
Date: Wed, 03 Aug 2016 18:44:15 +0200
Message-ID: <2367246.tp1XcRvkfJ@xps13>
References: <1467309817-11739-1-git-send-email-john.mcnamara@intel.com>
 <3844504.Omypy6q39V@xps13> <20160803143222.GA13564@bricha3-MOBL3>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: Bruce Richardson <bruce.richardson@intel.com>, dev@dpdk.org
To: John McNamara <john.mcnamara@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wm0-f47.google.com (mail-wm0-f47.google.com [74.125.82.47])
 by dpdk.org (Postfix) with ESMTP id 3B2752C29
 for <dev@dpdk.org>; Wed,  3 Aug 2016 18:44:17 +0200 (CEST)
Received: by mail-wm0-f47.google.com with SMTP id i5so344861089wmg.0
 for <dev@dpdk.org>; Wed, 03 Aug 2016 09:44:17 -0700 (PDT)
In-Reply-To: <20160803143222.GA13564@bricha3-MOBL3>
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

2016-08-03 15:32, Bruce Richardson:
> 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!

As John is not available for some days, I've decided to make the
above suggested changes.

Applied, thanks