summaryrefslogtreecommitdiffstats
path: root/scripts/lib/devtool/deploy.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:42 +0000
commit32ef52389833a8b8dfb63444ace6561bb0ac741c (patch)
tree59f597df4ce685609706c7db90ee0eb654b044a5 /scripts/lib/devtool/deploy.py
parent9f7df76eb49eac1ec7627061a8219e5d0b052034 (diff)
downloadpoky-32ef52389833a8b8dfb63444ace6561bb0ac741c.tar.gz
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). (From OE-Core rev: e1b9d31e6ea3c254ecfe940fe795af44761e0e69) 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/deploy.py')
-rw-r--r--scripts/lib/devtool/deploy.py8
1 files changed, 6 insertions, 2 deletions
diff --git a/scripts/lib/devtool/deploy.py b/scripts/lib/devtool/deploy.py
index c90c6b1f76..0236c53726 100644
--- a/scripts/lib/devtool/deploy.py
+++ b/scripts/lib/devtool/deploy.py
@@ -131,7 +131,9 @@ def undeploy(args, config, basepath, workspace):
131 131
132def register_commands(subparsers, context): 132def register_commands(subparsers, context):
133 """Register devtool subcommands from the deploy plugin""" 133 """Register devtool subcommands from the deploy plugin"""
134 parser_deploy = subparsers.add_parser('deploy-target', help='Deploy recipe output files to live target machine') 134 parser_deploy = subparsers.add_parser('deploy-target',
135 help='Deploy recipe output files to live target machine',
136 group='testbuild')
135 parser_deploy.add_argument('recipename', help='Recipe to deploy') 137 parser_deploy.add_argument('recipename', help='Recipe to deploy')
136 parser_deploy.add_argument('target', help='Live target machine running an ssh server: user@hostname[:destdir]') 138 parser_deploy.add_argument('target', help='Live target machine running an ssh server: user@hostname[:destdir]')
137 parser_deploy.add_argument('-c', '--no-host-check', help='Disable ssh host key checking', action='store_true') 139 parser_deploy.add_argument('-c', '--no-host-check', help='Disable ssh host key checking', action='store_true')
@@ -139,7 +141,9 @@ def register_commands(subparsers, context):
139 parser_deploy.add_argument('-n', '--dry-run', help='List files to be deployed only', action='store_true') 141 parser_deploy.add_argument('-n', '--dry-run', help='List files to be deployed only', action='store_true')
140 parser_deploy.set_defaults(func=deploy) 142 parser_deploy.set_defaults(func=deploy)
141 143
142 parser_undeploy = subparsers.add_parser('undeploy-target', help='Undeploy recipe output files in live target machine') 144 parser_undeploy = subparsers.add_parser('undeploy-target',
145 help='Undeploy recipe output files in live target machine',
146 group='testbuild')
143 parser_undeploy.add_argument('recipename', help='Recipe to undeploy') 147 parser_undeploy.add_argument('recipename', help='Recipe to undeploy')
144 parser_undeploy.add_argument('target', help='Live target machine running an ssh server: user@hostname') 148 parser_undeploy.add_argument('target', help='Live target machine running an ssh server: user@hostname')
145 parser_undeploy.add_argument('-c', '--no-host-check', help='Disable ssh host key checking', action='store_true') 149 parser_undeploy.add_argument('-c', '--no-host-check', help='Disable ssh host key checking', action='store_true')