From mboxrd@z Thu Jan  1 00:00:00 1970
From: Neil Horman <nhorman@tuxdriver.com>
Subject: Re: [PATCH] doc: fix abi check script examples
Date: Tue, 19 Mar 2019 13:19:46 -0400
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
Cc: dev@dpdk.org, stable@dpdk.org, Olivier Matz <olivier.matz@6wind.com>
To: David Marchand <david.marchand@redhat.com>
Return-path: <dev-bounces@dpdk.org>
Content-Disposition: inline
In-Reply-To: <1553004318-3848-1-git-send-email-david.marchand@redhat.com>
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 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 <olivier.matz@6wind.com>
> Cc: Neil Horman <nhorman@tuxdriver.com>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
>  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 <REV1> <REV2> <TARGET>
> +   ./devtools/validate-abi.sh <REV1> <REV2>
>  
>  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 <nhorman@tuxdriver.com>