It was noticed that not all public headers were included in the doxygen
build, and once built not all files were listed in the index file
serving as a point of entry for the HTML version.
Bruce Richardson provided an idea and a draft implementation of the
configuration-time check, which I optimized to avoid repeat grep calls
and expanded to include indexing check.
After all drivers and public headers were included, multiple small
problems have surfaced fixes for which (with one exception covered by
bug 1962) are also included in this patch set.
v2:
* switched from `splitlines()` to `strip('\n').split('\n')` for
compatibility with older versions of meson;
* rebased on fresh main and updated BPF header links in the index file;
Marat Khalili (7):
doc: detect ignored public headers
doc: document rte_os.h
doc: fix typos in rte_bus_pci.h
doc: fix typos in rte_bus_vmbus.h
doc: add missing globs to doxy-api.conf.in
doc: add missing drivers to doxy-api.conf.in
doc: add missing headers to doxy-api-index.md
doc/api/doxy-api-index.md | 120 ++++++++++++++++++++++++++----
doc/api/doxy-api.conf.in | 17 ++++-
drivers/bus/pci/rte_bus_pci.h | 4 +-
drivers/bus/vmbus/rte_bus_vmbus.h | 33 ++++----
drivers/meson.build | 17 +++++
lib/eal/include/generic/rte_os.h | 13 ++++
lib/meson.build | 23 ++++++
meson.build | 19 +++++
8 files changed, 214 insertions(+), 32 deletions(-)
create mode 100644 lib/eal/include/generic/rte_os.h
--
2.43.0
