[dpdk-dev] [PATCH v1] doc: autogenerate nic overview table from ini files

Mcnamara, John john.mcnamara at intel.com
Fri Jul 8 21:52:53 CEST 2016


> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> Sent: Thursday, June 30, 2016 7:25 PM
> To: Mcnamara, John <john.mcnamara at intel.com>
> Cc: dev at dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v1] doc: autogenerate nic overview table
> from ini files
> 
> 2016-06-30 19:03, John McNamara:
> > This patch converts the NIC feature table in the overview doc into a
> > set of ini files and adds some functions into the Sphinx conf.py file
> > to convert them back into an RST table.
> >
> Would it be possible to make it a bit more generic and reusable to
> generate other tables of this kind?

It would be possible (in the technical sense) but probably not worth the
effort. :-)


> > * Blank entries in the PMD ini files are optional. They will get a
> default
> >   blank entry in the RST table based on the entries in the default.ini
> file.
> >   The ini files in this patch were generated programmatically from the
> >   original RST table.
> 
> I don't think there is a benefit to have blank entries in the .ini file.
> And there would be less conflicts if the guideline was to avoid blank
> entries when adding a new feature.

I can generate a set of ini files without blank entries if that is the
preference.  For some PMDs that will mean that there are no entries in
the file, apart from the heading, but I guess that is okay.  I'll change
that in v2.

> 
> PDF output is restrictive :)

Yes, and the PDF infrastructure is a bit of a pain but we still get a lot
of people in the field who like them and ask for them after releases.

Maybe they read them on the beach, on holidays.

John


More information about the dev mailing list