From mboxrd@z Thu Jan  1 00:00:00 1970
From: Luca Boccassi <bluca@debian.org>
Subject: [PATCH 1/4] mk: use script to generate examples.dox
Date: Fri, 31 Aug 2018 19:20:52 +0100
Message-ID: <20180831182055.30772-2-bluca@debian.org>
References: <20180831182055.30772-1-bluca@debian.org>
Cc: bruce.richardson@intel.com, john.mcnamara@intel.com,
 marko.kovacevic@intel.com, thomas@monjalon.net
To: dev@dpdk.org
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wr1-f67.google.com (mail-wr1-f67.google.com
 [209.85.221.67]) by dpdk.org (Postfix) with ESMTP id 706B45F19
 for <dev@dpdk.org>; Fri, 31 Aug 2018 20:21:08 +0200 (CEST)
Received: by mail-wr1-f67.google.com with SMTP id j26-v6so12020149wre.2
 for <dev@dpdk.org>; Fri, 31 Aug 2018 11:21:08 -0700 (PDT)
In-Reply-To: <20180831182055.30772-1-bluca@debian.org>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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>
---
 doc/api/generate_examples.sh | 14 ++++++++++++++
 mk/rte.sdkdoc.mk             |  5 +----
 2 files changed, 15 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..9633a64f7a
--- /dev/null
+++ b/doc/api/generate_examples.sh
@@ -0,0 +1,14 @@
+#! /bin/sh -e
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2018 Luca Boccassi <bluca@debian.org>
+
+EXAMPLES_DIR=$1
+API_EXAMPLES=$2
+
+# SC2129 - avoid multiple individual redirects
+{ \
+    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'; \
+} > "${API_EXAMPLES}"
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