DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: Thomas Monjalon <thomas.monjalon@6wind.com>
Cc: John McNamara <john.mcnamara@intel.com>, dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v3] doc: autogenerate nic overview table from ini files
Date: Wed, 3 Aug 2016 15:32:22 +0100	[thread overview]
Message-ID: <20160803143222.GA13564@bricha3-MOBL3> (raw)
In-Reply-To: <3844504.Omypy6q39V@xps13>

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

  reply	other threads:[~2016-08-03 14:32 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-06-30 18:03 [dpdk-dev] [PATCH v1] " John McNamara
2016-06-30 18:03 ` John McNamara
2016-06-30 18:25 ` Thomas Monjalon
2016-07-01  1:40   ` Yuanhan Liu
2016-07-08 19:52   ` Mcnamara, John
2016-07-17 12:59 ` [dpdk-dev] [PATCH v2] " John McNamara
2016-07-19 13:08   ` Ferruh Yigit
2016-07-29 11:59 ` [dpdk-dev] [PATCH v3] " John McNamara
2016-07-29 12:02   ` Mcnamara, John
2016-08-01 21:37   ` Thomas Monjalon
2016-08-03 14:32     ` Bruce Richardson [this message]
2016-08-03 16:44       ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160803143222.GA13564@bricha3-MOBL3 \
    --to=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=thomas.monjalon@6wind.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).