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 88BCA1B45A
 for <dev@dpdk.org>; Wed, 28 Nov 2018 13:35:24 +0100 (CET)
Received: from cpe-2606-a000-111b-453b-47b2-cd7-599-8cfa.dyn6.twc.com
 ([2606:a000:111b:453b:47b2:cd7:599:8cfa] helo=localhost)
 by smtp.tuxdriver.com with esmtpsa (TLSv1:AES256-SHA:256) (Exim 4.63)
 (envelope-from <nhorman@tuxdriver.com>)
 id 1gRjAb-0002Ct-53; Tue, 27 Nov 2018 14:37:33 -0500
Date: Wed, 28 Nov 2018 07:34:32 -0500
From: Neil Horman <nhorman@tuxdriver.com>
To: David Marchand <david.marchand@redhat.com>
Cc: dev@dpdk.org, thomas@monjalon.net, echaudro@redhat.com
Message-ID: <20181128123432.GC32491@hmswarspite.think-freely.org>
References: <1543400933-1723-1-git-send-email-david.marchand@redhat.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1543400933-1723-1-git-send-email-david.marchand@redhat.com>
User-Agent: Mutt/1.10.1 (2018-07-13)
X-Spam-Score: 0.3 (/)
X-Spam-Status: No
Subject: Re: [dpdk-dev] [PATCH 1/2] devtools: report the incorrect section
 when complaining
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://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>
X-List-Received-Date: Wed, 28 Nov 2018 12:35:25 -0000

On Wed, Nov 28, 2018 at 11:28:52AM +0100, David Marchand wrote:
> It does not hurt reporting the incriminated section.
> 
> Before:
> ERROR: symbol rte_meter_trtcm_rfc4115_color_aware_check is added in a
> section other than the EXPERIMENTAL section of the version map
> 
> After:
> ERROR: symbol rte_meter_trtcm_rfc4115_color_aware_check is added in
> +EXPERIMENTAL section other than the EXPERIMENTAL section of the
> version map
> 
nit: Its a bit odd in the changelog to have an example in which the incorect
section being reported matches the expected section.  I.e. its confusing to read
"... is added in +EXPERIMENTAL section other than the EXPERIMENTAL section".
Might be better to change the language of the report below and the example to be
something like:

ERROR: symbol <SYMBOL> is added in the <VERSION> section, but is expected to be
added in the EXPERIMENTAL section

ACK to the notion of reporting the offending section though.  Thats a good idea.

Neil

> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> 
> Used http://patchwork.dpdk.org/patch/48354/ to test.
> 
> ---
>  devtools/check-symbol-change.sh | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/devtools/check-symbol-change.sh b/devtools/check-symbol-change.sh
> index 1d21e91..66741be 100755
> --- a/devtools/check-symbol-change.sh
> +++ b/devtools/check-symbol-change.sh
> @@ -115,7 +115,7 @@ check_for_rule_violations()
>  				if [ $? -ne 0 ]
>  				then
>  					echo -n "ERROR: symbol $symname "
> -					echo -n "is added in a section "
> +					echo -n "is added in $secname section "
>  					echo -n "other than the EXPERIMENTAL "
>  					echo "section of the version map"
>  					ret=1
> -- 
> 1.8.3.1
> 
>