From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-f66.google.com (mail-wr1-f66.google.com [209.85.221.66]) by dpdk.org (Postfix) with ESMTP id 9E7544C93 for ; Fri, 7 Sep 2018 18:55:32 +0200 (CEST) Received: by mail-wr1-f66.google.com with SMTP id v16-v6so15609007wro.11 for ; Fri, 07 Sep 2018 09:55:32 -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=86noOSY95UBMRCNCKDjg96tB88aosmNdgf+OCxTl0eI=; b=sQdAlivNNO1HwsssCHjBwQS9HFQa6aUsSD7HIEl8ASeoQFYkFqg8iVUOuSNUnp6m8/ IqXwES2uho9bvXY1qGoHVd7DpxMm1ATrwCb8JPoZGlIgpAhaNL1wvE115UrIq4py/CEX uNH0Y1svkdGNGIAKGGlpHz2aC2V4eI/Gi+/WPzKL+WO9HLfQDxO6flDw/geLaOSDCue6 lZWbcgPuKka7c7v+xEibAd4cMktropP2FdJukcbcARG4MTqcPgNTMdQWF2y+jbx7VPVS ohVU8rK9RQxpvKXBpGGfhuYuTv48Cq85KYdjFxc33qy1J57qnjvSpITmQr+WBPNeiTUY gEMA== X-Gm-Message-State: APzg51Cm3pIe9x031Htu+Ia3Qq/bypd18jN6TF1KSrVaVe4+eZGApmZf GTIg9lq4PkHFa3YGIurCIfN1Xr+x/iI= X-Google-Smtp-Source: ANB0VdY2UECsjrL287EvtfIVeiVihZtRI5L7AJBK/7/n0uX3LPECobpiQBUk3awZMaygtY7W9zSwhg== X-Received: by 2002:adf:a41c:: with SMTP id d28-v6mr6587842wra.121.1536339332037; Fri, 07 Sep 2018 09:55:32 -0700 (PDT) Received: from localhost ([2a01:4b00:f419:6f00:8361:8946:ba2b:d556]) by smtp.gmail.com with ESMTPSA id j44-v6sm9220158wre.40.2018.09.07.09.55.29 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 07 Sep 2018 09:55:30 -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, 7 Sep 2018 17:55:21 +0100 Message-Id: <20180907165524.23982-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 v2 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, 07 Sep 2018 16:55:32 -0000 This will make it possible to generate the file in the same way from Meson as well. Signed-off-by: Luca Boccassi --- 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 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