From: Bruce Richardson <bruce.richardson@intel.com>
To: david.marchand@redhat.com, john.mcnamara@intel.com, bluca@debian.org
Cc: dev@dpdk.org, aconole@redhat.com, thomas@monjalon.net,
Bruce Richardson <bruce.richardson@intel.com>,
stable@dpdk.org
Subject: [dpdk-stable] [PATCH v4 6/6] doc/api: reduce indentation in meson build file
Date: Fri, 10 Jan 2020 21:52:05 +0000 [thread overview]
Message-ID: <20200110215205.513185-7-bruce.richardson@intel.com> (raw)
In-Reply-To: <20200110215205.513185-1-bruce.richardson@intel.com>
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>
---
@stable, this patch may be considered for backporting to 19.11 to allow
easier merging of other patches to the affected file.
---
doc/api/meson.build | 98 +++++++++++++++++++++++----------------------
1 file changed, 50 insertions(+), 48 deletions(-)
diff --git a/doc/api/meson.build b/doc/api/meson.build
index 23a7dfc75..c72b880e1 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -3,52 +3,54 @@
doxygen = find_program('doxygen', required: get_option('enable_docs'))
-if doxygen.found()
- # 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')
-
- inputdir = join_paths(meson.source_root(), 'examples')
- htmldir = join_paths('share', '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',
- input: inputdir,
- output: 'examples.dox',
- command: [generate_examples, '@INPUT@', '@OUTPUT@'],
- 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(meson.build_root(), 'doc', 'api', 'examples.dox'))
- cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
- cdata.set('HTML_OUTPUT', 'api')
- cdata.set('TOPDIR', meson.source_root())
- cdata.set('STRIP_FROM_PATH', meson.source_root())
-
- doxy_conf = configure_file(input: 'doxy-api.conf.in',
- output: 'doxy-api.conf',
- configuration: cdata)
-
- doxy_build = custom_target('doxygen',
- depends: example,
- input: doxy_conf,
- output: 'api',
- 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'
+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')
+
+inputdir = join_paths(meson.source_root(), 'examples')
+htmldir = join_paths('share', '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',
+ input: inputdir,
+ output: 'examples.dox',
+ command: [generate_examples, '@INPUT@', '@OUTPUT@'],
+ 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(meson.build_root(), 'doc', 'api', 'examples.dox'))
+cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
+cdata.set('HTML_OUTPUT', 'api')
+cdata.set('TOPDIR', meson.source_root())
+cdata.set('STRIP_FROM_PATH', meson.source_root())
+
+doxy_conf = configure_file(input: 'doxy-api.conf.in',
+ output: 'doxy-api.conf',
+ configuration: cdata)
+
+doxy_build = custom_target('doxygen',
+ depends: example,
+ input: doxy_conf,
+ output: 'api',
+ 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'
--
2.24.1
prev parent reply other threads:[~2020-01-10 21:52 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20200109115631.500056-1-bruce.richardson@intel.com>
[not found] ` <20200109153112.501282-1-bruce.richardson@intel.com>
[not found] ` <20200109153112.501282-4-bruce.richardson@intel.com>
[not found] ` <CAJFAV8whTkvXz99MHVxnSYdjr15eMCqaYbnh1fS3RGNdd=UD_g@mail.gmail.com>
2020-01-10 9:16 ` [dpdk-stable] [PATCH v3 3/6] doc/api: fix warning with meson build Bruce Richardson
[not found] ` <20200110215205.513185-1-bruce.richardson@intel.com>
2020-01-10 21:52 ` [dpdk-stable] [PATCH v4 1/6] kernel/linux/kni: fix meson warning about console keyword Bruce Richardson
2020-01-10 21:52 ` [dpdk-stable] [PATCH v4 3/6] doc/api: fix warning with meson build Bruce Richardson
2020-01-10 21:52 ` [dpdk-stable] [PATCH v4 4/6] doc/guides: reduce whitespace in meson build file Bruce Richardson
2020-01-10 21:52 ` Bruce Richardson [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200110215205.513185-7-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=aconole@redhat.com \
--cc=bluca@debian.org \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=stable@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).