From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <thomas.monjalon@6wind.com>
Received: from mail-wm0-f50.google.com (mail-wm0-f50.google.com [74.125.82.50])
 by dpdk.org (Postfix) with ESMTP id 09E6E952
 for <dev@dpdk.org>; Wed,  8 Feb 2017 13:08:32 +0100 (CET)
Received: by mail-wm0-f50.google.com with SMTP id c85so194638206wmi.1
 for <dev@dpdk.org>; Wed, 08 Feb 2017 04:08:32 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=6wind-com.20150623.gappssmtp.com; s=20150623;
 h=from:to:cc:subject:date:message-id:user-agent:in-reply-to
 :references:mime-version:content-transfer-encoding;
 bh=OaodDvh1ypXqPlsfnRaQai6wW0B3NbXazWONUifg4g0=;
 b=gPzU+M5DO9SaOUF5NtMXpHHqQs6WTOLhk9yQKjREB7Mh7PTLiDVnyvoVQ5gycgYdK4
 S9y/OfzUgUIa87AI77QxGYv+0z1jKB3QPYXuP7DSqoWtZ02hOXHqnj5fMRBMemeiTc4m
 2Q/OoekBanBRkWt1WZGmqQ/+shYB6ZX/G/dW9pbP4FCebvUIDJjellzxoHTW79zbROPi
 RYZIkqYUUqBnz17w3Nn5iZMEn8UQ/W4uGrNqQsEvifYHqZl7marF8iwunAQMnDn/TunH
 l7aAZRdLsj+xvAQul12m5FcpBo6Z9hgPmUQh8Jst/7LOyFxrlBA0aziF+8UaH3AdhpuT
 PXkA==
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:user-agent
 :in-reply-to:references:mime-version:content-transfer-encoding;
 bh=OaodDvh1ypXqPlsfnRaQai6wW0B3NbXazWONUifg4g0=;
 b=HRNjl1PVoAzumwaOGSIW7URYqexvrpMG3BDX4YZJwHHtAgeCXFTc56wXB3gsnYvbXo
 xkXjzshlEn3Hejh5r/bpFU+lIRApKUHrS5LDdgmDSZn8A/BBoQ3WaM2VRnbetmt1vSwQ
 hzOJRb43zLBfQk9q+sQqpvNLeCyeA39PeQaM3EbeNwHt+yxVkulQ3rdRsubRSVwYl4Qm
 BcOW76dTbcD9+tgiWjyHVnxu7F/MOWnnUN35YFHJhNsrMbg/zqjjYqcn6W6MDMuAyGQl
 Z12eWapQJXRRtdV0du+Li0taGlhHWyz0ms31sZ9ztbwPubW7wZ6J5tpvA8l5T6rOoFNd
 qDPQ==
X-Gm-Message-State: AMke39kn/tRSv0oO2RKKRD2yowFNQtx6HMsSfiRlgco7PwbDn49SK5X7shpwrjDcOOH6b1Iu
X-Received: by 10.28.98.194 with SMTP id w185mr19147721wmb.84.1486555712602;
 Wed, 08 Feb 2017 04:08:32 -0800 (PST)
Received: from xps13.localnet (host.78.145.23.62.rev.coltfrance.com.
 [62.23.145.78])
 by smtp.gmail.com with ESMTPSA id b15sm12677643wra.4.2017.02.08.04.08.31
 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
 Wed, 08 Feb 2017 04:08:31 -0800 (PST)
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>
Cc: John McNamara <john.mcnamara@intel.com>, dev@dpdk.org
Date: Wed, 08 Feb 2017 13:08:28 +0100
Message-ID: <1665905.OHHQAK7vyE@xps13>
User-Agent: KMail/4.14.10 (Linux/4.5.4-1-ARCH; KDE/4.14.11; x86_64; ; )
In-Reply-To: <20170127173728.21618-1-ferruh.yigit@intel.com>
References: <2081164.5ClB4gsZ3F@xps13>
 <20170127173728.21618-1-ferruh.yigit@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
Subject: Re: [dpdk-dev] [PATCH v2] doc: automate examples file list for API
	doc
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 08 Feb 2017 12:08:33 -0000

2017-01-27 17:37, Ferruh Yigit:
> These files are linked to API documentation as usage samples, list of
> files created automatically during doc creation.
> 
> Remove manually updated old one.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
[...]
> +API_EXAMPLES := $(RTE_OUTPUT)/doc/html/examples.dox

I feel it should be in $(RTE_OUTPUT)/doc/ because the doc could be generated
in another format (not HTML only).

[...]

>  	@echo 'doxygen for API...'
>  	$(Q)mkdir -p $(RTE_OUTPUT)/doc/html
>  	$(Q)(cat $(RTE_SDK)/doc/api/doxy-api.conf     && \
> +	    echo INPUT           += $(API_EXAMPLES)   && \
>  	    printf 'PROJECT_NUMBER = '                && \
>  	                      $(MAKE) -rR showversion && \

It would be nicer to see INPUT here.

>  	    echo OUTPUT_DIRECTORY = $(RTE_OUTPUT)/doc && \

[...]

> +$(API_EXAMPLES):
> +	$(Q)mkdir -p $(RTE_OUTPUT)/doc/html
> +	@echo "/**" > $(API_EXAMPLES)
> +	@echo "@page examples DPDK Example Programs" >> $(API_EXAMPLES)
> +	@echo "" >> $(API_EXAMPLES)
> +	@find examples -type f -name "*.c" | awk '{ print "@example", $$0 }' >> $(API_EXAMPLES)

May I suggest this simpler syntax?
	find examples -type f -name '*.c' -printf '@example %p\n'

Please prefer simple quotes where possible.