[v2,1/4] mk: use script to generate examples.dox
Checks
Commit Message
This will make it possible to generate the file in the same way from
Meson as well.
Signed-off-by: Luca Boccassi <bluca@debian.org>
---
v2: simplified script by using exec > file
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
Comments
On Fri, Sep 07, 2018 at 05:55:21PM +0100, Luca Boccassi wrote:
> This will make it possible to generate the file in the same way from
> Meson as well.
>
> Signed-off-by: Luca Boccassi <bluca@debian.org>
> ---
Couple of comments on patch 4, otherwise looks ok to me.
Series-acked-by: Bruce Richardson <bruce.richardson@intel.com>
new file mode 100755
@@ -0,0 +1,12 @@
+#! /bin/sh -e
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2018 Luca Boccassi <bluca@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'
@@ -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: