diff options
author | Paul Eggleton <paul.eggleton@linux.intel.com> | 2015-12-22 17:02:54 +1300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2015-12-28 09:25:12 +0000 |
commit | 8e0a84c90175cc2fedff0272abda073ee270b876 (patch) | |
tree | cc5e7a7778ffe12e0376cb7c06f1c1d69b79dfe9 /scripts/devtool | |
parent | 548d4332e827cc9ae13fd57517a42fa0f139880f (diff) | |
download | poky-8e0a84c90175cc2fedff0272abda073ee270b876.tar.gz |
scripts: print usage in argparse-using scripts when a command-line error occurs
For scripts that use Python's standard argparse module to parse
command-line arguments, create a subclass which will show the usage
the usage information when a command-line parsing error occurs. The most
common case would be when the script is run with no arguments; at least
then the user immediately gets to see what arguments they might need to
pass instead of just an error message.
(From OE-Core rev: d62fe7c9bc2df6a4464440a3cae0539074bf99aa)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'scripts/devtool')
-rwxr-xr-x | scripts/devtool | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/scripts/devtool b/scripts/devtool index 9d3287c6d3..955495ea33 100755 --- a/scripts/devtool +++ b/scripts/devtool | |||
@@ -37,6 +37,7 @@ lib_path = scripts_path + '/lib' | |||
37 | sys.path = sys.path + [lib_path] | 37 | sys.path = sys.path + [lib_path] |
38 | from devtool import DevtoolError, setup_tinfoil | 38 | from devtool import DevtoolError, setup_tinfoil |
39 | import scriptutils | 39 | import scriptutils |
40 | import argparse_oe | ||
40 | logger = scriptutils.logger_create('devtool') | 41 | logger = scriptutils.logger_create('devtool') |
41 | 42 | ||
42 | plugins = [] | 43 | plugins = [] |
@@ -185,9 +186,9 @@ def main(): | |||
185 | break | 186 | break |
186 | pth = os.path.dirname(pth) | 187 | pth = os.path.dirname(pth) |
187 | 188 | ||
188 | parser = argparse.ArgumentParser(description="OpenEmbedded development tool", | 189 | parser = argparse_oe.ArgumentParser(description="OpenEmbedded development tool", |
189 | add_help=False, | 190 | add_help=False, |
190 | epilog="Use %(prog)s <subcommand> --help to get help on a specific command") | 191 | epilog="Use %(prog)s <subcommand> --help to get help on a specific command") |
191 | parser.add_argument('--basepath', help='Base directory of SDK / build directory') | 192 | parser.add_argument('--basepath', help='Base directory of SDK / build directory') |
192 | parser.add_argument('--bbpath', help='Explicitly specify the BBPATH, rather than getting it from the metadata') | 193 | parser.add_argument('--bbpath', help='Explicitly specify the BBPATH, rather than getting it from the metadata') |
193 | parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true') | 194 | parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true') |