Re: [PATCH v3] doc: autogenerate nic overview table from ini files
From: Thomas Monjalon <hidden>
Date: 2016-08-03 16:44:17
2016-08-03 15:32, Bruce Richardson:
On Mon, Aug 01, 2016 at 11:37:03PM +0200, Thomas Monjalon wrote:quoted
Hi John, 2016-07-29 12:59, John McNamara:quoted
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.quoted
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:quoted
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. ThanksThose 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