From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [dpdk-dev] [PATCH 1/2] doc/api: generate dependency file for examples doc
Date: Fri, 17 Jan 2020 11:22:35 +0000 [thread overview]
Message-ID: <20200117112236.5225-2-bruce.richardson@intel.com> (raw)
In-Reply-To: <20200117112236.5225-1-bruce.richardson@intel.com>
For the doxygen API for the examples folder, we can generate a build
dependency file when we generate the examples.dox file. This allows
correct rebuilds if the files in examples change.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/api/generate_examples.sh | 4 ++++
doc/api/meson.build | 5 ++---
2 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/doc/api/generate_examples.sh b/doc/api/generate_examples.sh
index 6fcfe513b..dae7ee0be 100755
--- a/doc/api/generate_examples.sh
+++ b/doc/api/generate_examples.sh
@@ -5,6 +5,10 @@
EXAMPLES_DIR=$1
API_EXAMPLES=$2
+# generate a .d file including both C files and also build files, so we can
+# detect both file changes and file additions/deletions
+echo "$API_EXAMPLES: $(find ${EXAMPLES_DIR} -type f \( -name '*.c' -o -name 'meson.build' \) -printf '%p ' )" > ${API_EXAMPLES}.d
+
exec > "${API_EXAMPLES}"
printf '/**\n'
printf '@page examples DPDK Example Programs\n\n'
diff --git a/doc/api/meson.build b/doc/api/meson.build
index c72b880e1..899e930fa 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -15,7 +15,6 @@ 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
@@ -24,9 +23,9 @@ htmldir = join_paths('share', 'doc', 'dpdk')
# 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@'],
+ command: [generate_examples, join_paths(meson.source_root(), 'examples'), '@OUTPUT@'],
+ depfile: 'examples.dox.d',
install: get_option('enable_docs'),
install_dir: htmldir,
build_by_default: get_option('enable_docs'))
--
2.20.1
next prev parent reply other threads:[~2020-01-17 11:25 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-17 11:22 [dpdk-dev] [PATCH 0/2] Do proper dependency tracking for doxygen Bruce Richardson
2020-01-17 11:22 ` Bruce Richardson [this message]
2020-01-17 11:51 ` [dpdk-dev] [PATCH 1/2] doc/api: generate dependency file for examples doc Luca Boccassi
2020-01-17 11:22 ` [dpdk-dev] [PATCH 2/2] doc/api: track header files to rebuild docs on change Bruce Richardson
2020-01-17 11:51 ` Luca Boccassi
2020-02-15 16:58 ` [dpdk-dev] [PATCH 0/2] Do proper dependency tracking for doxygen Thomas Monjalon
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=20200117112236.5225-2-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
/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).