From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-f65.google.com (mail-wr1-f65.google.com [209.85.221.65]) by dpdk.org (Postfix) with ESMTP id 5CEA34C74 for ; Tue, 11 Sep 2018 22:42:42 +0200 (CEST) Received: by mail-wr1-f65.google.com with SMTP id s14-v6so18447827wrw.6 for ; Tue, 11 Sep 2018 13:42:42 -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=ys9IJNs+xYGj53wT2wMGuU5uJiXBD+rKnF5jk0EjsP0=; b=MSPkgLD01guzGVBK4Sona0XKVO+PM9VrxwN2ZvV0AzgLWnsZXlHNpOITdIb8A9jSvj 1b9X1kHSIwT4Jm890zUO/AMQpPFc0XcKIZixkqiMpud2eU2af6QX1AbEi3fvOK6cnCDu KxEIePc3wVWn/ey2dtPw0/+23WXuIahISx/Xz46cdjk2iimxKzBbibEAB/mOw0nZCkSv ya/ttug9F8P4+DZSrAf6Q1CA8cbjb0yFDo/G/EtE+diR9qw+RvUt+6/MWJ1HhUloZYJX 2aQAE1LwQ5JSJmMNpr7c9nm43dq+8m/TTvqzId8qMJ+733mxCcMs5kdXPzGgQ3L5y5vP 5ZoA== X-Gm-Message-State: APzg51BYM5PfBntvRNdQgbjVKfXDUg1Fb6YcMKOwKyJTiD3q9VQHKvp6 9NyK45wcORx0Biy/M14D1WDBEZPiErA= X-Google-Smtp-Source: ANB0VdbyxQdy2Rhgjoh0TKmRamDuZ4fuEs3TiXk60TJg4WHcdauzIfOmgIVkXRmZZFwYbmtIFRnegw== X-Received: by 2002:adf:db11:: with SMTP id s17-v6mr20991825wri.221.1536698561520; Tue, 11 Sep 2018 13:42:41 -0700 (PDT) Received: from localhost ([2a01:4b00:f419:6f00:8361:8946:ba2b:d556]) by smtp.gmail.com with ESMTPSA id z69-v6sm2816989wmz.18.2018.09.11.13.42.38 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 11 Sep 2018 13:42:38 -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: Tue, 11 Sep 2018 21:42:33 +0100 Message-Id: <20180911204236.21858-1-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 v5 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: Tue, 11 Sep 2018 20:42:42 -0000 This will make it possible to generate the file in the same way from Meson as well. Signed-off-by: Luca Boccassi Acked-by: Bruce Richardson --- 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 + +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