diff mbox

[dpdk-dev] scripts: enhance error message in get maintainer script

Message ID 20171214142140.23980-1-olivier.matz@6wind.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Olivier Matz Dec. 14, 2017, 2:21 p.m. UTC 
  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(-)

Comments

Ferruh Yigit Dec. 14, 2017, 5:36 p.m. UTC | #1 
On 12/14/2017 6:21 AM, Olivier Matz wrote:
> 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>
Thomas Monjalon Jan. 4, 2018, 5:16 p.m. UTC | #2 
14/12/2017 18:36, Ferruh Yigit:
> On 12/14/2017 6:21 AM, Olivier Matz wrote:
> > 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>

Applied, thanks
diff mbox

Patch

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