summaryrefslogtreecommitdiffstats
path: root/scripts/recipetool
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2015-12-22 17:02:54 +1300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-12-28 09:25:12 +0000
commit8e0a84c90175cc2fedff0272abda073ee270b876 (patch)
treecc5e7a7778ffe12e0376cb7c06f1c1d69b79dfe9 /scripts/recipetool
parent548d4332e827cc9ae13fd57517a42fa0f139880f (diff)
downloadpoky-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/recipetool')
-rwxr-xr-xscripts/recipetool7
1 files changed, 4 insertions, 3 deletions
diff --git a/scripts/recipetool b/scripts/recipetool
index 791a66aaca..1198cc25d7 100755
--- a/scripts/recipetool
+++ b/scripts/recipetool
@@ -27,6 +27,7 @@ scripts_path = os.path.dirname(os.path.realpath(__file__))
27lib_path = scripts_path + '/lib' 27lib_path = scripts_path + '/lib'
28sys.path = sys.path + [lib_path] 28sys.path = sys.path + [lib_path]
29import scriptutils 29import scriptutils
30import argparse_oe
30logger = scriptutils.logger_create('recipetool') 31logger = scriptutils.logger_create('recipetool')
31 32
32plugins = [] 33plugins = []
@@ -45,9 +46,9 @@ def main():
45 logger.error("This script can only be run after initialising the build environment (e.g. by using oe-init-build-env)") 46 logger.error("This script can only be run after initialising the build environment (e.g. by using oe-init-build-env)")
46 sys.exit(1) 47 sys.exit(1)
47 48
48 parser = argparse.ArgumentParser(description="OpenEmbedded recipe tool", 49 parser = argparse_oe.ArgumentParser(description="OpenEmbedded recipe tool",
49 add_help=False, 50 add_help=False,
50 epilog="Use %(prog)s <subcommand> --help to get help on a specific command") 51 epilog="Use %(prog)s <subcommand> --help to get help on a specific command")
51 parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true') 52 parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true')
52 parser.add_argument('-q', '--quiet', help='Print only errors', action='store_true') 53 parser.add_argument('-q', '--quiet', help='Print only errors', action='store_true')
53 parser.add_argument('--color', choices=['auto', 'always', 'never'], default='auto', help='Colorize output (where %(metavar)s is %(choices)s)', metavar='COLOR') 54 parser.add_argument('--color', choices=['auto', 'always', 'never'], default='auto', help='Colorize output (where %(metavar)s is %(choices)s)', metavar='COLOR')