[dpdk-dev] [PATCH 4/4] build: generate API documentation with Meson

Luca Boccassi bluca at debian.org
Mon Sep 3 11:34:57 CEST 2018


On Mon, 2018-09-03 at 03:09 +0200, Thomas Monjalon wrote:
> 31/08/2018 20:20, Luca Boccassi:
> > Both a configuration-time "enable_docs" boolean option and an
> > optional
> > 'ninja doc' target are available. Note that due to a Meson bug for
> > now
> > the latter will only build, but not install the files.
> > 
> > Signed-off-by: Luca Boccassi <bluca at debian.org>
> > ---
> >  doc/api/generate_doxygen.sh | 10 ++++++++
> >  doc/api/meson.build         | 51
> > +++++++++++++++++++++++++++++++++++++
> >  doc/build-sdk-meson.txt     |  2 ++
> >  doc/meson.build             |  4 +++
> >  meson.build                 |  3 +++
> >  meson_options.txt           |  2 ++
> >  6 files changed, 72 insertions(+)
> 
> You use generate_doxygen.sh only with meson?
> Shouldn't we use the same in mk/rte.sdkdoc.mk?

I was kinda hoping somebody would be able to suggest an alternative
that avoids the need for generate_doxygen.sh - the issue being that
with Meson's "custom_target" you can't specify a subdirectory in
input/ouput (and the directory is generated at build time so can't have
a meson.build in it), and also you cannot use the same "output" twice.

So I can't see a way to have an additional custom_target to run the CSS
generation, hence the script.

Changing the makefile to use the script will make it a bit more
complicated, as the doxygen file will need to be generated rather than
passed by piping stout/in, so the rule will have to be split into 3:
create directory -> create file -> call doxygen. Not sure it's worth
it?

-- 
Kind regards,
Luca Boccassi


More information about the dev mailing list