From: Thomas Monjalon <thomas.monjalon@6wind.com>
Date: Sun, 13 Dec 2015 02:00:48 +0000 (+0100)
Subject: scripts: add help for build testing
X-Git-Tag: spdx-start~7732
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=413244a484dc15dd4c0572ed85b3f07da81eaf1f;p=dpdk.git

scripts: add help for build testing

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---

diff --git a/scripts/test-build.sh b/scripts/test-build.sh
index 6e67c8fc68..6d28c5d553 100755
--- a/scripts/test-build.sh
+++ b/scripts/test-build.sh
@@ -40,7 +40,25 @@
 . scripts/load-devel-config.sh
 
 print_usage () {
-	echo "usage: $(basename $0) [-jX] [-s] [config1 [config2] ...]]"
+	echo "usage: $(basename $0) [-h] [-jX] [-s] [config1 [config2] ...]]"
+}
+
+print_help () {
+	echo 'Test building several targets with different options'
+	echo
+	print_usage
+	cat <<- END_OF_HELP
+
+	options:
+	        -h    this help
+	        -jX   use X parallel jobs in "make"
+	        -s    short test with only first config without examples/doc
+
+	config: defconfig name followed by switches delimited with "+" sign
+	        Example: x86_64-native-linuxapp-gcc+next+shared+combined
+	        Default is to enable most of the options.
+	        The external dependencies are setup with DPDK_DEP_* variables.
+	END_OF_HELP
 }
 
 J=$DPDK_MAKE_JOBS
@@ -49,7 +67,7 @@ while getopts hj:s ARG ; do
 	case $ARG in
 		j ) J=$OPTARG ;;
 		s ) short=true ;;
-		h ) print_usage ; exit 0 ;;
+		h ) print_help ; exit 0 ;;
 		? ) print_usage ; exit 1 ;;
 	esac
 done