[dpdk-dev] [PATCH v4 1/4] mk: use script to generate examples.dox
Luca Boccassi
bluca at debian.org
Mon Sep 10 22:09:57 CEST 2018
This will make it possible to generate the file in the same way from
Meson as well.
Signed-off-by: Luca Boccassi <bluca at debian.org>
Acked-by: Bruce Richardson <bruce.richardson at intel.com>
---
v2: simplified script by using exec > file
v4: add acked-by
doc/api/generate_examples.sh | 12 ++++++++++++
mk/rte.sdkdoc.mk | 5 +----
2 files changed, 13 insertions(+), 4 deletions(-)
create mode 100755 doc/api/generate_examples.sh
diff --git a/doc/api/generate_examples.sh b/doc/api/generate_examples.sh
new file mode 100755
index 0000000000..6fcfe513b6
--- /dev/null
+++ b/doc/api/generate_examples.sh
@@ -0,0 +1,12 @@
+#! /bin/sh -e
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2018 Luca Boccassi <bluca at debian.org>
+
+EXAMPLES_DIR=$1
+API_EXAMPLES=$2
+
+exec > "${API_EXAMPLES}"
+printf '/**\n'
+printf '@page examples DPDK Example Programs\n\n'
+find "${EXAMPLES_DIR}" -type f -name '*.c' -printf '@example examples/%P\n' | LC_ALL=C sort
+printf '*/\n'
diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index bd2e5763df..d023b720fe 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -63,10 +63,7 @@ api-html-clean:
$(API_EXAMPLES): api-html-clean
$(Q)mkdir -p $(@D)
- @printf '/**\n' > $(API_EXAMPLES)
- @printf '@page examples DPDK Example Programs\n\n' >> $(API_EXAMPLES)
- @find examples -type f -name '*.c' -printf '@example %p\n' | LC_ALL=C sort >> $(API_EXAMPLES)
- @printf '*/\n' >> $(API_EXAMPLES)
+ $(Q)doc/api/generate_examples.sh examples $(API_EXAMPLES)
guides-pdf-clean: guides-pdf-img-clean
guides-pdf-img-clean:
--
2.18.0
More information about the dev
mailing list