[0/4] Meson: build Doxygen documentation
mbox series

Message ID 20180831182055.30772-1-bluca@debian.org
Headers show
Series
  • Meson: build Doxygen documentation
Related show

Message

Luca Boccassi Aug. 31, 2018, 6:20 p.m. UTC
I have tested this by using diffoscope between the docs built by the
makefiles and by this Meson patchset, and verified they are all
identical.

There are both a new "doc" target (ninja doc) and a configuration
option. This is due to the following bug in Meson:
https://github.com/mesonbuild/meson/issues/4107
because of it it's not possible to have simply an optional target,
as its files will not be installed.
So by default the documentation is off, if one wants to just build it
'ninja doc' can be used, but if one wants to both build and install
the config option 'enable_docs' has to be enabled.

A couple of small refactoring was done to the makefile doc build, to
make things easier and doable by both build systems.

Luca Boccassi (4):
  mk: use script to generate examples.dox
  mk: use templated doxygen config, modified on the fly
  build: use same version as make showversion in Meson
  build: generate API documentation with Meson

 doc/api/doxy-api.conf        | 87 --------------------------------
 doc/api/doxy-api.conf.in     | 96 ++++++++++++++++++++++++++++++++++++
 doc/api/generate_doxygen.sh  | 10 ++++
 doc/api/generate_examples.sh | 14 ++++++
 doc/api/meson.build          | 51 +++++++++++++++++++
 doc/build-sdk-meson.txt      |  2 +
 doc/meson.build              |  4 ++
 meson.build                  |  5 +-
 meson_options.txt            |  2 +
 mk/rte.sdkdoc.mk             | 21 +++-----
 10 files changed, 191 insertions(+), 101 deletions(-)
 delete mode 100644 doc/api/doxy-api.conf
 create mode 100644 doc/api/doxy-api.conf.in
 create mode 100755 doc/api/generate_doxygen.sh
 create mode 100755 doc/api/generate_examples.sh
 create mode 100644 doc/api/meson.build
 create mode 100644 doc/meson.build