From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <nhorman@tuxdriver.com>
Received: from smtp.tuxdriver.com (charlotte.tuxdriver.com [70.61.120.58])
 by dpdk.org (Postfix) with ESMTP id 0D8AFA48F
 for <dev@dpdk.org>; Sun, 21 Jan 2018 23:07:58 +0100 (CET)
Received: from cpe-2606-a000-111b-4011-215-ff-fecc-4872.dyn6.twc.com
 ([2606:a000:111b:4011:215:ff:fecc:4872] helo=localhost)
 by smtp.tuxdriver.com with esmtpsa (TLSv1:AES256-SHA:256) (Exim 4.63)
 (envelope-from <nhorman@tuxdriver.com>)
 id 1edNmG-00055j-7b; Sun, 21 Jan 2018 17:07:55 -0500
Date: Sun, 21 Jan 2018 17:07:16 -0500
From: Neil Horman <nhorman@tuxdriver.com>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: dev@dpdk.org, john.mcnamara@intel.com, bruce.richardson@intel.com
Message-ID: <20180121220715.GA27512@neilslaptop.think-freely.org>
References: <20171201185628.16261-1-nhorman@tuxdriver.com>
 <20171213151728.16747-1-nhorman@tuxdriver.com>
 <20171213151728.16747-2-nhorman@tuxdriver.com>
 <2045197.kyHXX1r0IS@xps>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <2045197.kyHXX1r0IS@xps>
User-Agent: Mutt/1.9.1 (2017-09-22)
X-Spam-Score: -2.9 (--)
X-Spam-Status: No
Subject: Re: [dpdk-dev] [PATCHv4 1/5] buildtools: Add tool to check
 EXPERIMENTAL api exports
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://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: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Sun, 21 Jan 2018 22:07:58 -0000

On Sun, Jan 21, 2018 at 07:31:31PM +0100, Thomas Monjalon wrote:
> Hi Neil,
> 
> Sorry for the very late review.
> I thought review had been done by others but it seems not.
> Please find my comments below.
> 
> 13/12/2017 16:17, Neil Horman:
> >  create mode 100755 buildtools/experimentalsyms.sh
> 
> When adding a new file, you must reference it in MAINTAINERS.
> Please add it in the section "ABI versioning".
> 
yup

> > --- /dev/null
> > +++ b/buildtools/experimentalsyms.sh
> 
> I think the file name should include the word "check".
> What about check-experimental-syms.sh ?
> 
> > @@ -0,0 +1,35 @@
> > +#!/bin/sh
> 
> You must insert a SPDX license and copyright here.
> 
Will do.

> > +if [ -d $MAPFILE ]
> > +then
> > +	exit 0
> > +fi
> > +
> > +if [ -d $OBJFILE ]
> > +then
> > +	exit 0
> > +fi
> 
> Why checking for not being a directory?
> I guess you could check being a readable file (-r)?
> Should it return an error?
> 
The objfile check is out of date (had it in place initially, and is no longer
needed).  the mapfile check is there because dpdk apps use the same C_TO_O rule
and have no mapfile variable set.

> > +for i in `awk 'BEGIN {found=0}
> > +		/.*EXPERIMENTAL.*/ {found=1}
> > +		/.*}.*;/ {found=0}
> > +		/.*;/ {if (found == 1) print $1}' $MAPFILE`
> > +do
> > +	SYM=`echo $i | sed -e"s/;//"`
> > +	objdump -t $OBJFILE | grep -q "\.text.*$SYM"
> > +	IN_TEXT=$?
> > +	objdump -t $OBJFILE | grep -q "\.text\.experimental.*$SYM"
> > +	IN_EXP=$?
> > +	if [ $IN_TEXT -eq 0 -a $IN_EXP -ne 0 ]
> > +	then
> > +		echo "$SYM is not flagged as experimental"
> > +		echo "but is listed in version map"
> > +		echo "Please add __experimental to the definition of $SYM"
> > +		exit 1
> > +	fi
> > +done
> > +exit 0
> 
> exit 0 is useless at the end of a script.
Its there for clarity of exit value.  I prefer to be expicit in that.
Neil