From 1f1619994570210105ea9fa674562c11ce1921b3 Mon Sep 17 00:00:00 2001 From: Bruce Richardson Date: Tue, 29 Sep 2020 17:55:02 +0100 Subject: [PATCH] doc: make doxygen comply with meson werror option When the --werror meson build option is set, we can set the WARN_AS_ERRORS doxygen option in the doxygen config flag to get the same behaviour for API doc building as for building the rest of DPDK. This can help catch documentation errors sooner in the development process. Signed-off-by: Bruce Richardson --- doc/api/doxy-api.conf.in | 2 ++ doc/api/meson.build | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/doc/api/doxy-api.conf.in b/doc/api/doxy-api.conf.in index 42d38919d3..ddef755c21 100644 --- a/doc/api/doxy-api.conf.in +++ b/doc/api/doxy-api.conf.in @@ -108,3 +108,5 @@ GENERATE_LATEX = NO GENERATE_MAN = NO HAVE_DOT = NO + +WARN_AS_ERROR = @WARN_AS_ERROR@ diff --git a/doc/api/meson.build b/doc/api/meson.build index e9b49f9c2f..4f51f5d724 100644 --- a/doc/api/meson.build +++ b/doc/api/meson.build @@ -37,6 +37,10 @@ cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api')) cdata.set('HTML_OUTPUT', 'html') cdata.set('TOPDIR', meson.source_root()) cdata.set('STRIP_FROM_PATH', meson.source_root()) +cdata.set('WARN_AS_ERROR', 'NO') +if get_option('werror') + cdata.set('WARN_AS_ERROR', 'YES') +endif doxy_conf = configure_file(input: 'doxy-api.conf.in', output: 'doxy-api.conf', -- 2.20.1