summaryrefslogtreecommitdiff
path: root/scripts/lib/devtool/search.py
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2016-02-19 22:38:53 +1300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-02-21 09:32:00 +0000
commite1b9d31e6ea3c254ecfe940fe795af44761e0e69 (patch)
tree57d7be1ca898a2707a0919aea780bd2bb1bc070e /scripts/lib/devtool/search.py
parent391b9ba30d802ac420ddf382588e03e718861c01 (diff)
downloadopenembedded-core-e1b9d31e6ea3c254ecfe940fe795af44761e0e69.tar.gz
openembedded-core-e1b9d31e6ea3c254ecfe940fe795af44761e0e69.tar.bz2
openembedded-core-e1b9d31e6ea3c254ecfe940fe795af44761e0e69.zip
devtool: categorise and order subcommands in help output
The listing of subcommands in the --help output for devtool was starting to get difficult to follow, with commands appearing in no particular order (due to some being in separate modules and the order of those modules being parsed). Logically grouping the subcommands as well as being able to exercise some control over the order of the subcommands and groups would help, if we do so without losing the dynamic nature of the list (i.e. that it comes from the plugins). Argparse provides no built-in way to handle this and really, really makes it a pain to add, but with some subclassing and hacking it's now possible, and can be extended by any plugin as desired. To put a subcommand into a group, all you need to do is specify a group= parameter in the call to subparsers.add_parser(). you can also specify an order= parameter to make the subcommand sort higher or lower in the list (higher order numbers appear first, so use negative numbers to force items to the end if that's what you want). To add a new group, use subparsers.add_subparser_group(), supplying the name, description and optionally an order number for the group itself (again, higher numbers appear first). Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'scripts/lib/devtool/search.py')
-rw-r--r--scripts/lib/devtool/search.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/scripts/lib/devtool/search.py b/scripts/lib/devtool/search.py
index 2ea446237e..b44bed7f6f 100644
--- a/scripts/lib/devtool/search.py
+++ b/scripts/lib/devtool/search.py
@@ -82,6 +82,7 @@ def search(args, config, basepath, workspace):
def register_commands(subparsers, context):
"""Register devtool subcommands from this plugin"""
parser_search = subparsers.add_parser('search', help='Search available recipes',
- description='Searches for available target recipes. Matches on recipe name, package name, description and installed files, and prints the recipe name on match.')
+ description='Searches for available target recipes. Matches on recipe name, package name, description and installed files, and prints the recipe name on match.',
+ group='info')
parser_search.add_argument('keyword', help='Keyword to search for (regular expression syntax allowed)')
parser_search.set_defaults(func=search, no_workspace=True)