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/test-remote-image | |
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/test-remote-image')
-rwxr-xr-x | scripts/test-remote-image | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/scripts/test-remote-image b/scripts/test-remote-image index f3a44ebe51..97d03d7a78 100755 --- a/scripts/test-remote-image +++ b/scripts/test-remote-image | |||
@@ -38,6 +38,7 @@ lib_path = scripts_path + '/lib' | |||
38 | sys.path = sys.path + [lib_path] | 38 | sys.path = sys.path + [lib_path] |
39 | 39 | ||
40 | import scriptpath | 40 | import scriptpath |
41 | import argparse_oe | ||
41 | 42 | ||
42 | # Add meta/lib to sys.path | 43 | # Add meta/lib to sys.path |
43 | scriptpath.add_oe_lib_path() | 44 | scriptpath.add_oe_lib_path() |
@@ -82,7 +83,7 @@ log = logger_create() | |||
82 | # Define and return the arguments parser for the script | 83 | # Define and return the arguments parser for the script |
83 | def get_args_parser(): | 84 | def get_args_parser(): |
84 | description = "This script is used to run automated runtime tests using remotely published image files. You should prepare the build environment just like building local images and running the tests." | 85 | description = "This script is used to run automated runtime tests using remotely published image files. You should prepare the build environment just like building local images and running the tests." |
85 | parser = argparse.ArgumentParser(description=description) | 86 | parser = argparse_oe.ArgumentParser(description=description) |
86 | parser.add_argument('--image-types', required=True, action="store", nargs='*', dest="image_types", default=None, help='The image types to test(ex: core-image-minimal).') | 87 | parser.add_argument('--image-types', required=True, action="store", nargs='*', dest="image_types", default=None, help='The image types to test(ex: core-image-minimal).') |
87 | parser.add_argument('--repo-link', required=True, action="store", type=str, dest="repo_link", default=None, help='The link to the remote images repository.') | 88 | parser.add_argument('--repo-link', required=True, action="store", type=str, dest="repo_link", default=None, help='The link to the remote images repository.') |
88 | parser.add_argument('--required-packages', required=False, action="store", nargs='*', dest="required_packages", default=None, help='Required packages for the tests. They will be built before the testing begins.') | 89 | parser.add_argument('--required-packages', required=False, action="store", nargs='*', dest="required_packages", default=None, help='Required packages for the tests. They will be built before the testing begins.') |