From patchwork Mon Oct 12 08:08:29 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Conor Walsh X-Patchwork-Id: 80332 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 76A66A04B6; Mon, 12 Oct 2020 10:09:51 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 83BDC1D64C; Mon, 12 Oct 2020 10:09:02 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 7C48A1D635 for ; Mon, 12 Oct 2020 10:08:58 +0200 (CEST) IronPort-SDR: wmbgh4TTO3fYz4A1F2rLZXKQi7CTUn7RmijVMVO1kLTCkXrh8c4kMHMgZH3p3AB24ZlPXPfaXx 1eTg0mhEKdbA== X-IronPort-AV: E=McAfee;i="6000,8403,9771"; a="162239024" X-IronPort-AV: E=Sophos;i="5.77,366,1596524400"; d="scan'208";a="162239024" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Oct 2020 01:08:58 -0700 IronPort-SDR: emocWSs8iiU5K3/xkkmecWPYci9CG2F8g6fEG5eycurbnoOeo2BSKnBKJjJ8ydBSVUIotOmjsf f83n0G9PTw6A== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,366,1596524400"; d="scan'208";a="317841954" Received: from unknown (HELO silpixa00400466.ir.intel.com) ([10.237.213.195]) by orsmga006.jf.intel.com with ESMTP; 12 Oct 2020 01:08:56 -0700 From: Conor Walsh To: mdr@ashroe.eu, nhorman@tuxdriver.com, bruce.richardson@intel.com, thomas@monjalon.net, david.marchand@redhat.com Cc: dev@dpdk.org, Conor Walsh Date: Mon, 12 Oct 2020 08:08:29 +0000 Message-Id: <20201012080829.3446-5-conor.walsh@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201012080829.3446-1-conor.walsh@intel.com> References: <20200918121137.1370883-1-conor.walsh@intel.com> <20201012080829.3446-1-conor.walsh@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH v5 4/4] doc: test-meson-builds.sh doc updates 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" Updates to the Checking Compilation and Checking ABI compatibility sections of the patches part of the contribution guide Signed-off-by: Conor Walsh --- doc/guides/contributing/patches.rst | 43 ++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 9ff60944c..d45bb5ce1 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -470,10 +470,9 @@ The script internally checks for dependencies, then builds for several combinations of compilation configuration. By default, each build will be put in a subfolder of the current working directory. However, if it is preferred to place the builds in a different location, -the environment variable ``DPDK_BUILD_TEST_DIR`` can be set to that desired location. -For example, setting ``DPDK_BUILD_TEST_DIR=__builds`` will put all builds -in a single subfolder called "__builds" created in the current directory. -Setting ``DPDK_BUILD_TEST_DIR`` to an absolute directory path e.g. ``/tmp`` is also supported. +the environment variable ``DPDK_BUILD_TEST_DIR`` or the command line argument ``-b`` +can be set to that desired location. +Environmental variables can also be specified in ``.config/dpdk/devel.config``. .. _integrated_abi_check: @@ -483,14 +482,38 @@ Checking ABI compatibility By default, ABI compatibility checks are disabled. -To enable them, a reference version must be selected via the environment -variable ``DPDK_ABI_REF_VERSION``. +To enable ABI checks the required reference version must be set using either the +environment variable ``DPDK_ABI_REF_VERSION`` or the command line argument ``-a``. +The tag ``latest`` is supported, which will select the latest quarterly release. +e.g. ``./devtools/test-meson-builds.sh -a latest``. -The ``devtools/test-build.sh`` and ``devtools/test-meson-builds.sh`` scripts -then build this reference version in a temporary directory and store the +The ``devtools/test-meson-builds.sh`` script will then either build this reference version +or download a cached version when available in a temporary directory and store the results +in a subfolder of the current working directory. +The environment variable ``DPDK_ABI_REF_DIR`` or the argument ``-d`` can be set so that +the results go to a different location. +Environmental variables can also be specified in ``.config/dpdk/devel.config``. + + +.. _integrated_abi_check: + +Checking ABI compatibility +-------------------------- + +By default, ABI compatibility checks are disabled. + +To enable ABI checks the required reference version must be set using either +the environment variable ``DPDK_ABI_REF_VERSION`` or the argument ``-a``. +The tag ``latest`` is supported, which will select the latest quarterly release. +e.g. ``./devtools/test-meson-builds.sh -a latest``. + +The ``devtools/test-meson-builds.sh`` script will either build this reference version +or download a cached version if available in a temporary directory and store the results in a subfolder of the current working directory. -The environment variable ``DPDK_ABI_REF_DIR`` can be set so that the results go -to a different location. +The environment variable ``DPDK_ABI_REF_DIR`` or the argument ``-d`` can be set so that +the results go to a different location. +The environment variable ``DPDK_ABI_TAR_URI`` or the argument ``-u`` can be set to select +either a remote http location or local directory to download prebuilt ABI references from. Sending Patches