e16b972b1a
Starting in meson 0.56, the functions meson.source_root() and meson.build_root() are deprecated and to be replaced by the [more descriptive] functions: project_source_root()/global_source_root() and project_build_root()/global_build_root(). Unfortunately, these new replacement functions were only added in 0.56 release too, so to use them we would need version checks for old/new functions to remove the deprecation warnings. However, the functions "current_build_dir()" and "current_source_dir()" remain unaffected by all this, so we can bypass the versioning problem, by saving off these values to "dpdk_source_root" and "dpdk_build_root" in the top-level meson.build file Bugzilla ID: 926 Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Tested-by: Jerin Jacob <jerinj@marvell.com>
62 lines
2.3 KiB
Meson
62 lines
2.3 KiB
Meson
# SPDX-License-Identifier: BSD-3-Clause
|
|
# Copyright(c) 2018 Luca Boccassi <bluca@debian.org>
|
|
|
|
doxygen = find_program('doxygen', required: get_option('enable_docs'))
|
|
|
|
if not doxygen.found()
|
|
subdir_done()
|
|
endif
|
|
|
|
# due to the CSS customisation script, which needs to run on a file that
|
|
# is in a subdirectory that is created at build time and thus it cannot
|
|
# be an individual custom_target, we need to wrap the doxygen call in a
|
|
# script to run the CSS modification afterwards
|
|
generate_doxygen = find_program('generate_doxygen.sh')
|
|
generate_examples = find_program('generate_examples.sh')
|
|
generate_css = find_program('doxy-html-custom.sh')
|
|
|
|
htmldir = join_paths(get_option('datadir'), 'doc', 'dpdk')
|
|
|
|
# due to the following bug: https://github.com/mesonbuild/meson/issues/4107
|
|
# if install is set to true it will override build_by_default and it will
|
|
# cause the target to always be built. If install were to be always set to
|
|
# false it would be impossible to install the docs.
|
|
# So use a configure option for now.
|
|
example = custom_target('examples.dox',
|
|
output: 'examples.dox',
|
|
command: [generate_examples, join_paths(dpdk_source_root, 'examples'), '@OUTPUT@'],
|
|
depfile: 'examples.dox.d',
|
|
install: get_option('enable_docs'),
|
|
install_dir: htmldir,
|
|
build_by_default: get_option('enable_docs'))
|
|
|
|
cdata = configuration_data()
|
|
cdata.set('VERSION', meson.project_version())
|
|
cdata.set('API_EXAMPLES', join_paths(dpdk_build_root, 'doc', 'api', 'examples.dox'))
|
|
cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc', 'api'))
|
|
cdata.set('HTML_OUTPUT', 'html')
|
|
cdata.set('TOPDIR', dpdk_source_root)
|
|
cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dpdk_build_root, 'doc', 'api')]))
|
|
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',
|
|
configuration: cdata)
|
|
|
|
doxy_build = custom_target('doxygen',
|
|
depends: example,
|
|
depend_files: 'doxy-api-index.md',
|
|
input: doxy_conf,
|
|
output: 'html',
|
|
depfile: 'html.d',
|
|
command: [generate_doxygen, '@INPUT@', '@OUTPUT@', generate_css],
|
|
install: get_option('enable_docs'),
|
|
install_dir: htmldir,
|
|
build_by_default: get_option('enable_docs'))
|
|
|
|
doc_targets += doxy_build
|
|
doc_target_names += 'Doxygen_API'
|