From: Olivier Matz <olivier.matz@6wind.com>
Date: Thu, 14 Dec 2017 14:21:40 +0000 (+0100)
Subject: devtools: enhance error message in get maintainer script
X-Git-Tag: spdx-start~791
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=2ba9a32c96a1846ebfbb92c64640cfe233551ec1;p=dpdk.git

devtools: enhance error message in get maintainer script

When the DPDK_GETMAINTAINER_PATH variable was not set, the error
message from get-maintainer.sh was quite cheap:

	$ devtools/get-maintainer.sh --help
	usage: get-maintainer.sh <patch>
	Cannot execute DPDK_GETMAINTAINER_PATH

Add a more detailed explanation about this variable in the help.

Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
---

diff --git a/devtools/get-maintainer.sh b/devtools/get-maintainer.sh
index 5ae6b5aed1..5a25913078 100755
--- a/devtools/get-maintainer.sh
+++ b/devtools/get-maintainer.sh
@@ -42,15 +42,16 @@ options="$options --no-rolestats"
 print_usage () {
 	cat <<- END_OF_HELP
 	usage: $(basename $0) <patch>
+
+	The DPDK_GETMAINTAINER_PATH variable should be set to the full path to
+	the get_maintainer.pl script located in Linux kernel sources. Example:
+	DPDK_GETMAINTAINER_PATH=~/linux/scripts/get_maintainer.pl
+
+	Also refer to devtools/load-devel-config to store your configuration.
 	END_OF_HELP
 }
 
-# Requires DPDK_GETMAINTAINER_PATH devel config option set,
-# please check devtools/load-devel-config.
-# DPDK_GETMAINTAINER_PATH should be full path to the get_maintainer.pl script,
-# like:
-#   DPDK_GETMAINTAINER_PATH=~/linux/scripts/get_maintainer.pl
-
+# Requires DPDK_GETMAINTAINER_PATH devel config option set
 if [ ! -x "$DPDK_GETMAINTAINER_PATH" ] ; then
 	print_usage >&2
 	echo