[oe-commits] Paul Eggleton : recipetool: improve command-line help

[git at git.openembedded.org]

Module: openembedded-core.git
Branch: master
Commit: 2c59b2b20c32577085645056e4cbf4f9c259e4d7
URL:    http://git.openembedded.org/?p=openembedded-core.git&a=commit;h=2c59b2b20c32577085645056e4cbf4f9c259e4d7

Author: Paul Eggleton <paul.eggleton at linux.intel.com>
Date:   Thu Feb  5 14:04:00 2015 +0000

recipetool: improve command-line help

Based on feedback from Scott Rifenbark <scott.m.rifenbark at intel.com>

Signed-off-by: Paul Eggleton <paul.eggleton at linux.intel.com>
Signed-off-by: Ross Burton <ross.burton at intel.com>

---

 scripts/lib/recipetool/create.py | 8 +++++---
 scripts/recipetool               | 6 +++---
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/scripts/lib/recipetool/create.py b/scripts/lib/recipetool/create.py
index 38f5ead..290fc13 100644
--- a/scripts/lib/recipetool/create.py
+++ b/scripts/lib/recipetool/create.py
@@ -406,10 +406,12 @@ def convert_debian(debpath):
 
 
 def register_command(subparsers):
-    parser_create = subparsers.add_parser('create', help='Create a new recipe')
+    parser_create = subparsers.add_parser('create',
+                                          help='Create a new recipe',
+                                          description='Creates a new recipe from a source tree')
     parser_create.add_argument('source', help='Path or URL to source')
-    parser_create.add_argument('-o', '--outfile', help='Full path and filename to recipe to add', required=True)
+    parser_create.add_argument('-o', '--outfile', help='Specify filename for recipe to create', required=True)
     parser_create.add_argument('-m', '--machine', help='Make recipe machine-specific as opposed to architecture-specific', action='store_true')
-    parser_create.add_argument('-x', '--externalsrc', help='Assuming source is a URL, fetch it and extract it to the specified directory')
+    parser_create.add_argument('-x', '--extract-to', metavar='EXTRACTPATH', help='Assuming source is a URL, fetch it and extract it to the directory specified as %(metavar)s')
     parser_create.set_defaults(func=create_recipe)
 
diff --git a/scripts/recipetool b/scripts/recipetool
index 70e6b6c..2cfa763 100755
--- a/scripts/recipetool
+++ b/scripts/recipetool
@@ -49,11 +49,11 @@ def main():
         sys.exit(1)
 
     parser = argparse.ArgumentParser(description="OpenEmbedded recipe tool",
-                                     epilog="Use %(prog)s <command> --help to get help on a specific command")
+                                     epilog="Use %(prog)s <subcommand> --help to get help on a specific command")
     parser.add_argument('-d', '--debug', help='Enable debug output', action='store_true')
     parser.add_argument('-q', '--quiet', help='Print only errors', action='store_true')
-    parser.add_argument('--color', help='Colorize output', choices=['auto', 'always', 'never'], default='auto')
-    subparsers = parser.add_subparsers()
+    parser.add_argument('--color', choices=['auto', 'always', 'never'], default='auto', help='Colorize output (where %(metavar)s is %(choices)s)', metavar='COLOR')
+    subparsers = parser.add_subparsers(title='subcommands', metavar='<subcommand>')
 
     scriptutils.load_plugins(logger, plugins, os.path.join(scripts_path, 'lib', 'recipetool'))
     registered = False