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 B2BB5A00E6 for ; Tue, 19 Mar 2019 15:05:34 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 9012D4C95; Tue, 19 Mar 2019 15:05:34 +0100 (CET) Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by dpdk.org (Postfix) with ESMTP id 1BC082C30; Tue, 19 Mar 2019 15:05:33 +0100 (CET) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 7AB68C024912; Tue, 19 Mar 2019 14:05:32 +0000 (UTC) Received: from dmarchan.remote.csb (ovpn-204-129.brq.redhat.com [10.40.204.129]) by smtp.corp.redhat.com (Postfix) with ESMTP id D70812854C; Tue, 19 Mar 2019 14:05:29 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: stable@dpdk.org, Olivier Matz , Neil Horman Date: Tue, 19 Mar 2019 15:05:18 +0100 Message-Id: <1553004318-3848-1-git-send-email-david.marchand@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.32]); Tue, 19 Mar 2019 14:05:32 +0000 (UTC) Subject: [dpdk-dev] [PATCH] doc: fix abi check script examples X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Content-Type: text/plain; charset="UTF-8" Message-ID: <20190319140518.X7_PPHdN_zdAaq2ySm8FL3omX4yXHbys6YFb9MpVnvU@z> 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