doc: generate NIC overview table from ini files
authorJohn McNamara <john.mcnamara@intel.com>
Fri, 29 Jul 2016 11:59:14 +0000 (12:59 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Wed, 3 Aug 2016 16:42:17 +0000 (18:42 +0200)
commit9db3f52126fbd759653b4092bce199dd040c1a8b
tree61ae999a251bbffb99888c075222b359354872ad
parentb0a1419a88efebac3a1d52987b7e634848f9c85e
doc: generate 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 <john.mcnamara@intel.com>
Tested-by: Ferruh Yigit <ferruh.yigit@intel.com>
43 files changed:
.gitignore
doc/guides/conf.py
doc/guides/nics/features/afpacket.ini [new file with mode: 0644]
doc/guides/nics/features/bnx2x.ini [new file with mode: 0644]
doc/guides/nics/features/bnx2x_vf.ini [new file with mode: 0644]
doc/guides/nics/features/bnxt.ini [new file with mode: 0644]
doc/guides/nics/features/bonding.ini [new file with mode: 0644]
doc/guides/nics/features/cxgbe.ini [new file with mode: 0644]
doc/guides/nics/features/default.ini [new file with mode: 0644]
doc/guides/nics/features/e1000.ini [new file with mode: 0644]
doc/guides/nics/features/ena.ini [new file with mode: 0644]
doc/guides/nics/features/enic.ini [new file with mode: 0644]
doc/guides/nics/features/fm10k.ini [new file with mode: 0644]
doc/guides/nics/features/fm10k_vec.ini [new file with mode: 0644]
doc/guides/nics/features/fm10k_vf.ini [new file with mode: 0644]
doc/guides/nics/features/fm10k_vf_vec.ini [new file with mode: 0644]
doc/guides/nics/features/i40e.ini [new file with mode: 0644]
doc/guides/nics/features/i40e_vec.ini [new file with mode: 0644]
doc/guides/nics/features/i40e_vf.ini [new file with mode: 0644]
doc/guides/nics/features/i40e_vf_vec.ini [new file with mode: 0644]
doc/guides/nics/features/igb.ini [new file with mode: 0644]
doc/guides/nics/features/igb_vf.ini [new file with mode: 0644]
doc/guides/nics/features/ixgbe.ini [new file with mode: 0644]
doc/guides/nics/features/ixgbe_vec.ini [new file with mode: 0644]
doc/guides/nics/features/ixgbe_vf.ini [new file with mode: 0644]
doc/guides/nics/features/ixgbe_vf_vec.ini [new file with mode: 0644]
doc/guides/nics/features/mlx4.ini [new file with mode: 0644]
doc/guides/nics/features/mlx5.ini [new file with mode: 0644]
doc/guides/nics/features/mpipe.ini [new file with mode: 0644]
doc/guides/nics/features/nfp.ini [new file with mode: 0644]
doc/guides/nics/features/null.ini [new file with mode: 0644]
doc/guides/nics/features/pcap.ini [new file with mode: 0644]
doc/guides/nics/features/qede.ini [new file with mode: 0644]
doc/guides/nics/features/qede_vf.ini [new file with mode: 0644]
doc/guides/nics/features/ring.ini [new file with mode: 0644]
doc/guides/nics/features/szedata2.ini [new file with mode: 0644]
doc/guides/nics/features/thunderx.ini [new file with mode: 0644]
doc/guides/nics/features/vhost.ini [new file with mode: 0644]
doc/guides/nics/features/virtio.ini [new file with mode: 0644]
doc/guides/nics/features/virtio_vec.ini [new file with mode: 0644]
doc/guides/nics/features/vmxnet3.ini [new file with mode: 0644]
doc/guides/nics/features/xenvirt.ini [new file with mode: 0644]
doc/guides/nics/overview.rst