From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 6FB74A00E6 for ; Tue, 19 Mar 2019 18:20:29 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 412471B19; Tue, 19 Mar 2019 18:20:29 +0100 (CET) Received: from smtp.tuxdriver.com (charlotte.tuxdriver.com [70.61.120.58]) by dpdk.org (Postfix) with ESMTP id DF2381B19; Tue, 19 Mar 2019 18:20:27 +0100 (CET) Received: from cpe-2606-a000-111b-405a-9816-2c85-c514-8f7a.dyn6.twc.com ([2606:a000:111b:405a:9816:2c85:c514:8f7a] helo=localhost) by smtp.tuxdriver.com with esmtpsa (TLSv1:AES256-SHA:256) (Exim 4.63) (envelope-from ) id 1h6IPQ-0002vk-QZ; Tue, 19 Mar 2019 13:20:25 -0400 Date: Tue, 19 Mar 2019 13:19:46 -0400 From: Neil Horman To: David Marchand Cc: dev@dpdk.org, stable@dpdk.org, Olivier Matz Message-ID: <20190319171946.GC3722@hmswarspite.think-freely.org> References: <1553004318-3848-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: <1553004318-3848-1-git-send-email-david.marchand@redhat.com> User-Agent: Mutt/1.11.3 (2019-02-01) X-Spam-Score: -2.9 (--) X-Spam-Status: No Subject: Re: [dpdk-stable] [PATCH] doc: fix abi check script examples X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Sender: "stable" On Tue, Mar 19, 2019 at 03:05:18PM +0100, David Marchand wrote: > The doc examples are not aligned on the script following the > incriminated commit. > > Fixes: c4a5fe3bf832 ("devtools: rework ABI checker script") > Cc: stable@dpdk.org > > Cc: Olivier Matz > Cc: Neil Horman > Signed-off-by: David Marchand > --- > doc/guides/contributing/versioning.rst | 19 +++++++++++-------- > 1 file changed, 11 insertions(+), 8 deletions(-) > > diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst > index e7b326b..98b8de3 100644 > --- a/doc/guides/contributing/versioning.rst > +++ b/doc/guides/contributing/versioning.rst > @@ -548,26 +548,29 @@ utilities which can be installed via a package manager. For example:: > > The syntax of the ``validate-abi.sh`` utility is:: > > - ./devtools/validate-abi.sh > + ./devtools/validate-abi.sh > > Where ``REV1`` and ``REV2`` are valid gitrevisions(7) > https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html > -on the local repo and target is the usual DPDK compilation target. > +on the local repo. > > For example:: > > # Check between the previous and latest commit: > - ./devtools/validate-abi.sh HEAD~1 HEAD x86_64-native-linux-gcc > + ./devtools/validate-abi.sh HEAD~1 HEAD > + > + # Check on a specific compilation target: > + ./devtools/validate-abi.sh -t x86_64-native-linux-gcc HEAD~1 HEAD > > # Check between two tags: > - ./devtools/validate-abi.sh v2.0.0 v2.1.0 x86_64-native-linux-gcc > + ./devtools/validate-abi.sh v2.0.0 v2.1.0 > > # Check between git master and local topic-branch "vhost-hacking": > - ./devtools/validate-abi.sh master vhost-hacking x86_64-native-linux-gcc > + ./devtools/validate-abi.sh master vhost-hacking > > After the validation script completes (it can take a while since it need to > compile both tags) it will create compatibility reports in the > -``./compat_report`` directory. Listed incompatibilities can be found as > -follows:: > +``./abi-check/compat_report`` directory. Listed incompatibilities can be found > +as follows:: > > - grep -lr Incompatible compat_reports/ > + grep -lr Incompatible abi-check/compat_reports/ > -- > 1.8.3.1 > > Acked-by: Neil Horman