From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 ; Fri, 31 Aug 2018 20:21:08 +0200 (CEST) Received: by mail-wr1-f67.google.com with SMTP id j26-v6so12020149wre.2 for ; Fri, 31 Aug 2018 11:21:08 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=3Iiolt75CP7KWZDcnlUSknmuGL21FxMDCHy+Z0lfoOI=; b=OTeLuB++75Mu29R9c1A4dx3O4fZ9ZjXY9CaAC6Z//24ScENp10BFfu1H5GIbDAu00Y XoJIish+KHxg25b1DhINg7A/fJj9f4r0RNAws3sN4pfDSeGRC4DUW6+ris/hNwK+oAyl dYP4AZ8Ab+UJ8ocJ+MAvT5Ub6I14SCfbDZPaaBRSt6EYDAoz0LRL63cywJxcryYqVqMl N/VtCH0Y3ys4LzQ05fmnxIhk3i2BRsnvnQkwEbbgnP4zRlSt2+z8L1cYsa9d5xE3kam8 Ug097Fl88RN21RJktQr1AGTee9EqDwHzd2GWlL7u9XAzaU9JMxYeeAqD2H49xwOoE97h H+SA== X-Gm-Message-State: APzg51DAK7QMPHACeVUVFRDJTqeINYayjePOEUIBj1bri/3gjBrXNxIQ bfhZp3iU7vE7TsIdIMli7gryBONH X-Google-Smtp-Source: ANB0VdY6SyiSDFeEFkMM1VwHmDcDfCn0342RpmaAPzMXWsdBHpD9qUuRyQwDVJrkF7/AuxtfYx0SSg== X-Received: by 2002:adf:ff82:: with SMTP id j2-v6mr1633374wrr.165.1535739667754; Fri, 31 Aug 2018 11:21:07 -0700 (PDT) Received: from localhost ([2a01:4b00:f419:6f00:8361:8946:ba2b:d556]) by smtp.gmail.com with ESMTPSA id 132-v6sm4557308wmd.13.2018.08.31.11.21.06 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 31 Aug 2018 11:21:06 -0700 (PDT) From: Luca Boccassi To: dev@dpdk.org Cc: bruce.richardson@intel.com, john.mcnamara@intel.com, marko.kovacevic@intel.com, thomas@monjalon.net Date: Fri, 31 Aug 2018 19:20:52 +0100 Message-Id: <20180831182055.30772-2-bluca@debian.org> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20180831182055.30772-1-bluca@debian.org> References: <20180831182055.30772-1-bluca@debian.org> Subject: [dpdk-dev] [PATCH 1/4] mk: use script to generate examples.dox X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 31 Aug 2018 18:21:09 -0000 This will make it possible to generate the file in the same way from Meson as well. Signed-off-by: Luca Boccassi --- 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 + +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