[dpdk-dev] [PATCH v2] devtools: control location of test builds

[Thomas Monjalon]

From: Bruce Richardson <bruce.richardson at intel.com>

By default, both test-build.sh and test-meson-builds.sh scripts create the
builds they generate in the current working directory, leading to a large
number of build directories being present when testing patches. This
patchset modifies both scripts to use a DPDK_BUILD_TEST_DIR environment
variable to control where the build outputs are put.

For example, doing:
    export DPDK_BUILD_TEST_DIR=__builds
    ./devtools/test-meson-builds.sh && ./devtools/test-build.sh \
            x86_64-native-linux-clang+shared i686-native-linux-gcc

gives a "__builds" directory with 14 meson and 2 make builds (with the
meson build count depending on compiler availability)

Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
---
v2:
- rename DPDK_TEST_BUILD_DIR to DPDK_BUILD_TEST_DIR
- add comment in devtools/test-build.sh and its guide section
- load from config file in test-meson-builds.sh
---
 devtools/test-build.sh              | 4 +++-
 devtools/test-meson-builds.sh       | 9 ++++++---
 doc/guides/contributing/patches.rst | 7 +++++++
 3 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/devtools/test-build.sh b/devtools/test-build.sh
index 2bedbdb980..f55d3120aa 100755
--- a/devtools/test-build.sh
+++ b/devtools/test-build.sh
@@ -7,6 +7,7 @@ default_path=$PATH
 # Load config options:
 # - ARMV8_CRYPTO_LIB_PATH
 # - DPDK_BUILD_TEST_CONFIGS (defconfig1+option1+option2 defconfig2)
+# - DPDK_BUILD_TEST_DIR
 # - DPDK_DEP_ARCHIVE
 # - DPDK_DEP_BPF (y/[n])
 # - DPDK_DEP_CFLAGS
@@ -63,6 +64,7 @@ print_help () {
 [ -z $MAKE ] && echo "Cannot find make or gmake" && exit 1
 
 J=$DPDK_MAKE_JOBS
+builds_dir=${DPDK_BUILD_TEST_DIR:-.}
 short=false
 unset verbose
 maxerr=-Wfatal-errors
@@ -234,7 +236,7 @@ for conf in $configs ; do
 	. $(dirname $(readlink -f $0))/load-devel-config
 
 	options=$(echo $conf | sed 's,[^~+]*,,')
-	dir=$conf
+	dir=$builds_dir/$conf
 	config $dir $target $options
 
 	echo "================== Build $dir"
diff --git a/devtools/test-meson-builds.sh b/devtools/test-meson-builds.sh
index 07d42985e6..571deec257 100755
--- a/devtools/test-meson-builds.sh
+++ b/devtools/test-meson-builds.sh
@@ -12,8 +12,11 @@ PIPEFAIL=""
 set -o | grep -q pipefail && set -o pipefail && PIPEFAIL=1
 
 srcdir=$(dirname $(readlink -f $0))/..
+. $srcdir/devtools/load-devel-config
+
 MESON=${MESON:-meson}
 use_shared="--default-library=shared"
+builds_dir=${DPDK_BUILD_TEST_DIR:-.}
 
 if command -v gmake >/dev/null 2>&1 ; then
 	MAKE=gmake
@@ -50,7 +53,7 @@ load_env () # <target compiler>
 
 build () # <directory> <target compiler> <meson options>
 {
-	builddir=$1
+	builddir=$builds_dir/$1
 	shift
 	targetcc=$1
 	shift
@@ -125,8 +128,8 @@ done
 
 # Test installation of the x86-default target, to be used for checking
 # the sample apps build using the pkg-config file for cflags and libs
-build_path=build-x86-default
-export DESTDIR=$(pwd)/$build_path/install-root
+build_path=$(readlink -f $builds_dir/build-x86-default)
+export DESTDIR=$build_path/install-root
 $ninja_cmd -C $build_path install
 
 load_env cc
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 2140303464..e3246aca5e 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -471,6 +471,7 @@ Examples of configs are::
 The builds can be modified via the following environmental variables:
 
 * ``DPDK_BUILD_TEST_CONFIGS`` (target1+option1+option2 target2)
+* ``DPDK_BUILD_TEST_DIR``
 * ``DPDK_DEP_CFLAGS``
 * ``DPDK_DEP_LDFLAGS``
 * ``DPDK_DEP_PCAP`` (y/[n])
@@ -495,6 +496,12 @@ Compilation of patches is to be tested with ``devtools/test-meson-builds.sh`` sc
 
 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.
 
 
 Sending Patches
-- 
2.23.0