From patchwork Mon Sep 10 16:13:03 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Boccassi X-Patchwork-Id: 44519 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 17C994C92; Mon, 10 Sep 2018 18:13:17 +0200 (CEST) Received: from mail-wm0-f66.google.com (mail-wm0-f66.google.com [74.125.82.66]) by dpdk.org (Postfix) with ESMTP id F0F874C90 for ; Mon, 10 Sep 2018 18:13:14 +0200 (CEST) Received: by mail-wm0-f66.google.com with SMTP id c14-v6so22144416wmb.4 for ; Mon, 10 Sep 2018 09:13:14 -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=uFK86OIA118AsLmZ6qmiq3wxU1kLywO+XECcPCL31ppJHMdZpCwibNT+luTMpIcZqQ fudaYcwSsJS6Pa1AvNmwLgLd7Q+hBvaOhPqqzwmL+jd2E5tDsUxO3VcrHQKQ8MHvSO05 hp9N4bn/QGOq2rRdmkLKpK21ZvgJ+HqueyzugbaLjbpycAUN3/Z15M39tFexvtMLfHXd fhl2QUi8i/n0EuEqW3nSDkl2r00FGWVfmjRAuzmDhD+k/GlmkwSOb5vaad/Ucrl8zd5C +4WB+NUYN7Csh5/jmGjnj1CZwY7iWuEZ84I12CdcQXtWFPO1MEBchWFyZn+hY0GYmycQ kZbg== X-Gm-Message-State: APzg51Dzy4iSfPtVTRsr0mqBbjmFwuiJ+8od1Hak+06STSEOcoaFm+av DcYPE+6FYU32EseeyKJVAx+04kjE X-Google-Smtp-Source: ANB0VdYDkMhxG3OLPwtk7a2v+dfWGRKT6LxPdzbj9YXbtrp/q/LEBLsrOSlbkIZwVuG+jjCDG1CJbQ== X-Received: by 2002:a1c:5f85:: with SMTP id t127-v6mr1276218wmb.16.1536595994204; Mon, 10 Sep 2018 09:13:14 -0700 (PDT) Received: from localhost ([2a01:4b00:f419:6f00:8361:8946:ba2b:d556]) by smtp.gmail.com with ESMTPSA id c19-v6sm16160394wre.86.2018.09.10.09.13.12 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 10 Sep 2018 09:13:13 -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: Mon, 10 Sep 2018 17:13:03 +0100 Message-Id: <20180910161306.12568-1-bluca@debian.org> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20180907165524.23982-1-bluca@debian.org> References: <20180907165524.23982-1-bluca@debian.org> Subject: [dpdk-dev] [PATCH v3 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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: