d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
32ae9939d9
numam-dpdk/doc/api/meson.build

61 lines
2.3 KiB
Meson
Raw Normal View History

build: generate API documentation with meson Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:36 +00:00
# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2018 Luca Boccassi <bluca@debian.org>
doxygen = find_program('doxygen', required: get_option('enable_docs'))
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
if not doxygen.found()
subdir_done()
build: generate API documentation with meson Signed-off-by: Luca Boccassi <bluca@debian.org> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
2018-09-11 20:42:36 +00:00
endif
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
# 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
doc: rewrite shell scripts in Python Shell used in documentation generation could not run on Windows. Rewrite scripts in Python. New scripts use proper path separators and handle paths with spaces. Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com> Reviewed-by: Bruce Richardson <bruce.richardson@intel.com>
2022-04-06 17:10:12 +00:00
generate_doxygen = py3 + files('generate_doxygen.py')
generate_examples = py3 + files('generate_examples.py')
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
doc: add dependency on header files for API doxygen Generate a dependency file for the header files used in the API guide so that the docs can be rebuilt if a header changes. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-17 11:22:36 +00:00
htmldir = join_paths(get_option('datadir'), 'doc', 'dpdk')
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
# 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',
build: change indentation in infrastructure files Switch from using tabs to 4 spaces for meson.build indentation, for the basic infrastructure and tooling files, as well as doc and kernel directories. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:23 +00:00
output: 'examples.dox',
build: remove deprecated Meson functions 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>
2022-01-24 17:49:59 +00:00
command: [generate_examples, join_paths(dpdk_source_root, 'examples'), '@OUTPUT@'],
build: change indentation in infrastructure files Switch from using tabs to 4 spaces for meson.build indentation, for the basic infrastructure and tooling files, as well as doc and kernel directories. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:23 +00:00
depfile: 'examples.dox.d',
install: get_option('enable_docs'),
install_dir: htmldir,
build_by_default: get_option('enable_docs'))
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
build: remove deprecated Meson functions 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>
2022-01-24 17:49:59 +00:00
cdata.set('API_EXAMPLES', join_paths(dpdk_build_root, 'doc', 'api', 'examples.dox'))
cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc', 'api'))
doc: align doxygen output folder with sphinx guides The API docs were output to "<build>/doc/api/api" folder, which was ugly-looking with the repeated "api", and inconsistent with the sphinx guides which were written to "<build>/doc/guides/html". Changing the doxygen output folder to "html" fixes both these issues. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2020-09-29 16:54:58 +00:00
cdata.set('HTML_OUTPUT', 'html')
build: remove deprecated Meson functions 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>
2022-01-24 17:49:59 +00:00
cdata.set('TOPDIR', dpdk_source_root)
cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dpdk_build_root, 'doc', 'api')]))
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 <bruce.richardson@intel.com>
2020-09-29 16:55:02 +00:00
cdata.set('WARN_AS_ERROR', 'NO')
if get_option('werror')
build: change indentation in infrastructure files Switch from using tabs to 4 spaces for meson.build indentation, for the basic infrastructure and tooling files, as well as doc and kernel directories. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:23 +00:00
cdata.set('WARN_AS_ERROR', 'YES')
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 <bruce.richardson@intel.com>
2020-09-29 16:55:02 +00:00
endif
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
doxy_conf = configure_file(input: 'doxy-api.conf.in',
build: change indentation in infrastructure files Switch from using tabs to 4 spaces for meson.build indentation, for the basic infrastructure and tooling files, as well as doc and kernel directories. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:23 +00:00
output: 'doxy-api.conf',
configuration: cdata)
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
doxy_build = custom_target('doxygen',
build: change indentation in infrastructure files Switch from using tabs to 4 spaces for meson.build indentation, for the basic infrastructure and tooling files, as well as doc and kernel directories. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:23 +00:00
depends: example,
depend_files: 'doxy-api-index.md',
input: doxy_conf,
output: 'html',
depfile: 'html.d',
doc: rewrite shell scripts in Python Shell used in documentation generation could not run on Windows. Rewrite scripts in Python. New scripts use proper path separators and handle paths with spaces. Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com> Reviewed-by: Bruce Richardson <bruce.richardson@intel.com>
2022-04-06 17:10:12 +00:00
command: [generate_doxygen, '@OUTPUT@', doxygen, '@INPUT@'],
build: change indentation in infrastructure files Switch from using tabs to 4 spaces for meson.build indentation, for the basic infrastructure and tooling files, as well as doc and kernel directories. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-20 10:22:23 +00:00
install: get_option('enable_docs'),
install_dir: htmldir,
build_by_default: get_option('enable_docs'))
doc: reduce indentation in meson build file When building the API docs, we can make the meson.build file easier to read, and allow more code per line, by using subdir_done() to quit early. Cc: stable@dpdk.org Signed-off-by: Bruce Richardson <bruce.richardson@intel.com> Acked-by: Aaron Conole <aconole@redhat.com> Acked-by: Luca Boccassi <bluca@debian.org>
2020-01-10 21:52:05 +00:00
doc_targets += doxy_build
doc_target_names += 'Doxygen_API'
Reference in New Issue Copy Permalink