[dpdk-dev] [PATCH v3] doc: autogenerate nic overview table from ini files
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
[dpdk-dev] [PATCH v3] doc: autogenerate nic overview table from ini files
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
[dpdk-dev] [PATCH v3] doc: autogenerate nic overview table from ini files
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
[dpdk-dev] [PATCH v3] doc: autogenerate nic overview table from ini files
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. 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. A NIC/PMD feature matrix is now an ini file like the following: $ head doc/guides/nics/nic_features/i40e.ini ; ; Features of the i40e network driver. ; [Features] Link status = Y Link status event= Y Rx interrupt = Y Queue start/stop = Y ... The output RST table matches the existing table with the column headers sorted. Signed-off-by: John McNamara Tested-by: Ferruh Yigit --- .gitignore | 2 + doc/guides/conf.py | 155 +++ doc/guides/nics/nic_features/afpacket.ini| 6 ++ doc/guides/nics/nic_features/bnx2x.ini | 16 +++ doc/guides/nics/nic_features/bnx2x_vf.ini| 17 +++ doc/guides/nics/nic_features/bnxt.ini| 16 +++ doc/guides/nics/nic_features/bonding.ini | 6 ++ doc/guides/nics/nic_features/cxgbe.ini | 31 ++ doc/guides/nics/nic_features/default.ini | 68 doc/guides/nics/nic_features/e1000.ini | 28 + doc/guides/nics/nic_features/ena.ini | 26 + doc/guides/nics/nic_features/enic.ini| 28 + 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 + doc/guides/nics/nic_features/mlx4.ini| 32 ++ doc/guides/nics/nic_features/mlx5.ini| 35 ++ doc/guides/nics/nic_features/mpipe.ini | 6 ++ doc/guides/nics/nic_features/nfp.ini | 6 ++ doc/guides/nics/nic_features/null.ini| 6 ++ doc/guides/nics/nic_features/pcap.ini| 16 +++ doc/guides/nics/nic_features/qede.ini| 29 + doc/guides/nics/nic_features/qede_vf.ini | 30 ++ doc/guides/nics/nic_features/ring.ini| 6 ++ doc/guides/nics/nic_features/szedata2.ini| 17 +++ doc/guides/nics/nic_features/thunderx.ini| 30 ++ doc/guides/nics/nic_features/vhost.ini | 13 +++ doc/guides/nics/nic_features/virtio.ini | 24 + doc/guides/nics/nic_features/virtio_vec.ini | 22 doc/guides/nics/nic_features/vmxnet3.ini | 6 ++ doc/guides/nics/nic_features/xenvirt.ini | 6 ++ doc/guides/nics/overview.rst | 76 + 43 files changed, 1195 insertions(+), 75 deletions(-) create mode 100644 doc/guides/nics/nic_features/afpacket.ini create mode 100644 doc/guides/nics/nic_features/bnx2x.ini create mode 100644 doc/guides/nics/nic_features/bnx2x_vf.ini create mode 100644 doc/guides/nics/nic_features/bnxt.ini create mode 100644 doc/guides/nics/nic_features/bonding.ini create mode 100644 doc/guides/nics/nic_features/cxgbe.ini create mode 100644 doc/guides/nics/nic_features/default.ini create mode 100644 doc/guides/nics/nic_features/e1000.ini create mode 100644 doc/guides/nics/nic_features/ena.ini create mode 100644 doc/guides/nics/nic_features/enic.ini create mode 100644 doc/guides/nics/nic_features/fm10k.ini create mode 100644 doc/guides/nics/nic_features/fm10k_vec.ini create mode 100644 doc/guides/nics/nic_features/fm10k_vf.ini create mode 100644 doc/guides/nics/nic_features/fm10kvf_vec.ini create mode 100644 doc/guides/nics/nic_features/i40e.ini create mode 100644 doc/guides/nics/nic_features/i40e_vec.ini create mode 100644 doc/guides/nics/nic_features/i40e_vf.ini create mode 100644 doc/guides/nics/nic_features/i40evf_vec.ini create mode 100644 doc/guides/nics/nic_features/igb.ini create mode 100644 doc/guides/nics/nic_features/igb_vf.ini create mode 100644 doc/guides/nics/nic_features/ixgbe.ini create mode 100644 doc/guides/nics/nic_features/ixgbe_vec.ini create mode 100644 doc/guides/nics/nic_features/ixgbe_vf.ini create mode 100644 doc/guides/nics/nic_features/ixgbevf_vec.ini create mode 100644 doc/guides/nics/nic_features/mlx4.ini create mode 100644 doc/guides/nics/nic_features/mlx5.ini create mode 100644
[dpdk-dev] [PATCH v3] doc: autogenerate nic overview table from ini files
I forgot to add the annotations: v3: * Updated to latest version of the nic overview table. v2: * Updated to latest version of the nic overview table. * Removed blank entries from the ini file.
