From mboxrd@z Thu Jan  1 00:00:00 1970
From: Bruce Richardson <bruce.richardson@intel.com>
Subject: Re: [PATCH 1/4] mk: use script to generate examples.dox
Date: Fri, 7 Sep 2018 17:13:22 +0100
Message-ID: <20180907161322.GA24984@bricha3-MOBL.ger.corp.intel.com>
References: <20180831182055.30772-1-bluca@debian.org>
 <20180831182055.30772-2-bluca@debian.org> <1746678.vtfpdfx8nV@xps>
 <1535965627.11823.37.camel@debian.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Transfer-Encoding: 8bit
Cc: Thomas Monjalon <thomas@monjalon.net>, dev@dpdk.org,
 john.mcnamara@intel.com, marko.kovacevic@intel.com
To: Luca Boccassi <bluca@debian.org>
Return-path: <dev-bounces@dpdk.org>
Received: from mga03.intel.com (mga03.intel.com [134.134.136.65])
 by dpdk.org (Postfix) with ESMTP id 71C724C8D
 for <dev@dpdk.org>; Fri,  7 Sep 2018 18:13:31 +0200 (CEST)
Content-Disposition: inline
In-Reply-To: <1535965627.11823.37.camel@debian.org>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

On Mon, Sep 03, 2018 at 10:07:07AM +0100, Luca Boccassi wrote:
> On Mon, 2018-09-03 at 02:54 +0200, Thomas Monjalon wrote:
> > 31/08/2018 20:20, Luca Boccassi:
> > > +# SC2129 - avoid multiple individual redirects
> > 
> > What is SC2129 ?
> 
> shellcheck - will clarify in v2
> 
> > > +{ \
> > > +    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}"
> > 
> > Why using backslashes (continuation lines)?
> 
> Good point, will remove in v2
>
Agree, rather than using continuation lines, I suggest one of the
following:
* use exec > ${API_EXAMPLES} at the top of the script
* let the script just print to stdout and have make/meson put that in the
  output file for you.

/Bruce