From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <olivier.matz@6wind.com>
Received: from proxy.6wind.com (host.76.145.23.62.rev.coltfrance.com
 [62.23.145.76]) by dpdk.org (Postfix) with ESMTP id 368C9107A
 for <dev@dpdk.org>; Thu, 14 Dec 2017 15:22:10 +0100 (CET)
Received: from glumotte.dev.6wind.com (unknown [10.16.0.195])
 by proxy.6wind.com (Postfix) with ESMTP id 2F772114574;
 Thu, 14 Dec 2017 15:13:45 +0100 (CET)
From: Olivier Matz <olivier.matz@6wind.com>
To: dev@dpdk.org,
	Thomas Monjalon <thomas@monjalon.net>
Date: Thu, 14 Dec 2017 15:21:40 +0100
Message-Id: <20171214142140.23980-1-olivier.matz@6wind.com>
X-Mailer: git-send-email 2.11.0
Subject: [dpdk-dev] [PATCH] scripts: enhance error message in get maintainer
	script
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 14 Dec 2017 14:22:10 -0000

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>
---
 devtools/get-maintainer.sh | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/devtools/get-maintainer.sh b/devtools/get-maintainer.sh
index 5ae6b5aed..5a2591307 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
-- 
2.11.0