summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2015-11-23 00:34:20 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-12-01 21:32:04 (GMT)
commit0b850cb231231371b496ae5ee6f7571c3de2f448 (patch)
tree3b084d24611dccee0ff173254646c1e0269845f0 /scripts
parent5001f23ecc5f380938cee8d7fcce053ea482d928 (diff)
downloadpoky-0b850cb231231371b496ae5ee6f7571c3de2f448.tar.gz
devtool: clarify help text
* Make some minor clarifications to help text * Drop ArgumentDefaultsHelpFormatter and just put the defaults in the text itself where needed (because otherwise you get defaults shown for store_true options which is somewhat confusing). (From OE-Core rev: a90ffea30c4578fd6acda2c5945b816ad33b13f5) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'scripts')
-rwxr-xr-xscripts/devtool2
-rw-r--r--scripts/lib/devtool/build.py3
-rw-r--r--scripts/lib/devtool/standard.py28
-rw-r--r--scripts/lib/devtool/upgrade.py4
4 files changed, 16 insertions, 21 deletions
diff --git a/scripts/devtool b/scripts/devtool
index 1fcb42c..9d3287c 100755
--- a/scripts/devtool
+++ b/scripts/devtool
@@ -258,7 +258,7 @@ def main():
258 258
259 if not context.fixed_setup: 259 if not context.fixed_setup:
260 parser_create_workspace = subparsers.add_parser('create-workspace', 260 parser_create_workspace = subparsers.add_parser('create-workspace',
261 help='Set up a workspace', 261 help='Set up workspace in an alternative location',
262 description='Sets up a new workspace. NOTE: other devtool subcommands will create a workspace automatically as needed, so you only need to use %(prog)s if you want to specify where the workspace should be located.') 262 description='Sets up a new workspace. NOTE: other devtool subcommands will create a workspace automatically as needed, so you only need to use %(prog)s if you want to specify where the workspace should be located.')
263 parser_create_workspace.add_argument('layerpath', nargs='?', help='Path in which the workspace layer should be created') 263 parser_create_workspace.add_argument('layerpath', nargs='?', help='Path in which the workspace layer should be created')
264 parser_create_workspace.add_argument('--create-only', action="store_true", help='Only create the workspace layer, do not alter configuration') 264 parser_create_workspace.add_argument('--create-only', action="store_true", help='Only create the workspace layer, do not alter configuration')
diff --git a/scripts/lib/devtool/build.py b/scripts/lib/devtool/build.py
index 0b8e88b..a9a0778 100644
--- a/scripts/lib/devtool/build.py
+++ b/scripts/lib/devtool/build.py
@@ -73,8 +73,7 @@ def build(args, config, basepath, workspace):
73def register_commands(subparsers, context): 73def register_commands(subparsers, context):
74 """Register devtool subcommands from this plugin""" 74 """Register devtool subcommands from this plugin"""
75 parser_build = subparsers.add_parser('build', help='Build a recipe', 75 parser_build = subparsers.add_parser('build', help='Build a recipe',
76 description='Builds the specified recipe using bitbake (up to and including do_%s)' % _get_build_task(context.config), 76 description='Builds the specified recipe using bitbake (up to and including do_%s)' % _get_build_task(context.config))
77 formatter_class=argparse.ArgumentDefaultsHelpFormatter)
78 parser_build.add_argument('recipename', help='Recipe to build') 77 parser_build.add_argument('recipename', help='Recipe to build')
79 parser_build.add_argument('-s', '--disable-parallel-make', action="store_true", help='Disable make parallelism') 78 parser_build.add_argument('-s', '--disable-parallel-make', action="store_true", help='Disable make parallelism')
80 parser_build.set_defaults(func=build) 79 parser_build.set_defaults(func=build)
diff --git a/scripts/lib/devtool/standard.py b/scripts/lib/devtool/standard.py
index 6de24eb..68d6eb9 100644
--- a/scripts/lib/devtool/standard.py
+++ b/scripts/lib/devtool/standard.py
@@ -1134,8 +1134,8 @@ def reset(args, config, basepath, workspace):
1134def register_commands(subparsers, context): 1134def register_commands(subparsers, context):
1135 """Register devtool subcommands from this plugin""" 1135 """Register devtool subcommands from this plugin"""
1136 parser_add = subparsers.add_parser('add', help='Add a new recipe', 1136 parser_add = subparsers.add_parser('add', help='Add a new recipe',
1137 description='Adds a new recipe') 1137 description='Adds a new recipe to the workspace to build a specified source tree')
1138 parser_add.add_argument('recipename', help='Name for new recipe to add') 1138 parser_add.add_argument('recipename', help='Name for new recipe to add (just name - no version, path or extension)')
1139 parser_add.add_argument('srctree', help='Path to external source tree') 1139 parser_add.add_argument('srctree', help='Path to external source tree')
1140 group = parser_add.add_mutually_exclusive_group() 1140 group = parser_add.add_mutually_exclusive_group()
1141 group.add_argument('--same-dir', '-s', help='Build in same directory as source', action="store_true") 1141 group.add_argument('--same-dir', '-s', help='Build in same directory as source', action="store_true")
@@ -1147,24 +1147,22 @@ def register_commands(subparsers, context):
1147 parser_add.set_defaults(func=add) 1147 parser_add.set_defaults(func=add)
1148 1148
1149 parser_modify = subparsers.add_parser('modify', help='Modify the source for an existing recipe', 1149 parser_modify = subparsers.add_parser('modify', help='Modify the source for an existing recipe',
1150 description='Enables modifying the source for an existing recipe', 1150 description='Enables modifying the source for an existing recipe')
1151 formatter_class=argparse.ArgumentDefaultsHelpFormatter) 1151 parser_modify.add_argument('recipename', help='Name of existing recipe to edit (just name - no version, path or extension)')
1152 parser_modify.add_argument('recipename', help='Name for recipe to edit')
1153 parser_modify.add_argument('srctree', help='Path to external source tree') 1152 parser_modify.add_argument('srctree', help='Path to external source tree')
1154 parser_modify.add_argument('--wildcard', '-w', action="store_true", help='Use wildcard for unversioned bbappend') 1153 parser_modify.add_argument('--wildcard', '-w', action="store_true", help='Use wildcard for unversioned bbappend')
1155 parser_modify.add_argument('--extract', '-x', action="store_true", help='Extract source as well') 1154 parser_modify.add_argument('--extract', '-x', action="store_true", help='Extract source as well')
1156 group = parser_modify.add_mutually_exclusive_group() 1155 group = parser_modify.add_mutually_exclusive_group()
1157 group.add_argument('--same-dir', '-s', help='Build in same directory as source', action="store_true") 1156 group.add_argument('--same-dir', '-s', help='Build in same directory as source', action="store_true")
1158 group.add_argument('--no-same-dir', help='Force build in a separate build directory', action="store_true") 1157 group.add_argument('--no-same-dir', help='Force build in a separate build directory', action="store_true")
1159 parser_modify.add_argument('--branch', '-b', default="devtool", help='Name for development branch to checkout (only when using -x)') 1158 parser_modify.add_argument('--branch', '-b', default="devtool", help='Name for development branch to checkout (only when using -x) (default "%(default)s")')
1160 parser_modify.set_defaults(func=modify) 1159 parser_modify.set_defaults(func=modify)
1161 1160
1162 parser_extract = subparsers.add_parser('extract', help='Extract the source for an existing recipe', 1161 parser_extract = subparsers.add_parser('extract', help='Extract the source for an existing recipe',
1163 description='Extracts the source for an existing recipe', 1162 description='Extracts the source for an existing recipe')
1164 formatter_class=argparse.ArgumentDefaultsHelpFormatter) 1163 parser_extract.add_argument('recipename', help='Name of recipe to extract the source for')
1165 parser_extract.add_argument('recipename', help='Name for recipe to extract the source for')
1166 parser_extract.add_argument('srctree', help='Path to where to extract the source tree') 1164 parser_extract.add_argument('srctree', help='Path to where to extract the source tree')
1167 parser_extract.add_argument('--branch', '-b', default="devtool", help='Name for development branch to checkout') 1165 parser_extract.add_argument('--branch', '-b', default="devtool", help='Name for development branch to checkout (default "%(default)s")')
1168 parser_extract.add_argument('--keep-temp', action="store_true", help='Keep temporary directory (for debugging)') 1166 parser_extract.add_argument('--keep-temp', action="store_true", help='Keep temporary directory (for debugging)')
1169 parser_extract.set_defaults(func=extract, no_workspace=True) 1167 parser_extract.set_defaults(func=extract, no_workspace=True)
1170 1168
@@ -1178,23 +1176,21 @@ def register_commands(subparsers, context):
1178 parser_sync.set_defaults(func=sync) 1176 parser_sync.set_defaults(func=sync)
1179 1177
1180 parser_update_recipe = subparsers.add_parser('update-recipe', help='Apply changes from external source tree to recipe', 1178 parser_update_recipe = subparsers.add_parser('update-recipe', help='Apply changes from external source tree to recipe',
1181 description='Applies changes from external source tree to a recipe (updating/adding/removing patches as necessary, or by updating SRCREV)') 1179 description='Applies changes from external source tree to a recipe (updating/adding/removing patches as necessary, or by updating SRCREV). Note that these changes need to have been committed to the git repository in order to be recognised.')
1182 parser_update_recipe.add_argument('recipename', help='Name of recipe to update') 1180 parser_update_recipe.add_argument('recipename', help='Name of recipe to update')
1183 parser_update_recipe.add_argument('--mode', '-m', choices=['patch', 'srcrev', 'auto'], default='auto', help='Update mode (where %(metavar)s is %(choices)s; default is %(default)s)', metavar='MODE') 1181 parser_update_recipe.add_argument('--mode', '-m', choices=['patch', 'srcrev', 'auto'], default='auto', help='Update mode (where %(metavar)s is %(choices)s; default is %(default)s)', metavar='MODE')
1184 parser_update_recipe.add_argument('--initial-rev', help='Starting revision for patches') 1182 parser_update_recipe.add_argument('--initial-rev', help='Override starting revision for patches')
1185 parser_update_recipe.add_argument('--append', '-a', help='Write changes to a bbappend in the specified layer instead of the recipe', metavar='LAYERDIR') 1183 parser_update_recipe.add_argument('--append', '-a', help='Write changes to a bbappend in the specified layer instead of the recipe', metavar='LAYERDIR')
1186 parser_update_recipe.add_argument('--wildcard-version', '-w', help='In conjunction with -a/--append, use a wildcard to make the bbappend apply to any recipe version', action='store_true') 1184 parser_update_recipe.add_argument('--wildcard-version', '-w', help='In conjunction with -a/--append, use a wildcard to make the bbappend apply to any recipe version', action='store_true')
1187 parser_update_recipe.add_argument('--no-remove', '-n', action="store_true", help='Don\'t remove patches, only add or update') 1185 parser_update_recipe.add_argument('--no-remove', '-n', action="store_true", help='Don\'t remove patches, only add or update')
1188 parser_update_recipe.set_defaults(func=update_recipe) 1186 parser_update_recipe.set_defaults(func=update_recipe)
1189 1187
1190 parser_status = subparsers.add_parser('status', help='Show workspace status', 1188 parser_status = subparsers.add_parser('status', help='Show workspace status',
1191 description='Lists recipes currently in your workspace and the paths to their respective external source trees', 1189 description='Lists recipes currently in your workspace and the paths to their respective external source trees')
1192 formatter_class=argparse.ArgumentDefaultsHelpFormatter)
1193 parser_status.set_defaults(func=status) 1190 parser_status.set_defaults(func=status)
1194 1191
1195 parser_reset = subparsers.add_parser('reset', help='Remove a recipe from your workspace', 1192 parser_reset = subparsers.add_parser('reset', help='Remove a recipe from your workspace',
1196 description='Removes the specified recipe from your workspace (resetting its state)', 1193 description='Removes the specified recipe from your workspace (resetting its state)')
1197 formatter_class=argparse.ArgumentDefaultsHelpFormatter)
1198 parser_reset.add_argument('recipename', nargs='?', help='Recipe to reset') 1194 parser_reset.add_argument('recipename', nargs='?', help='Recipe to reset')
1199 parser_reset.add_argument('--all', '-a', action="store_true", help='Reset all recipes (clear workspace)') 1195 parser_reset.add_argument('--all', '-a', action="store_true", help='Reset all recipes (clear workspace)')
1200 parser_reset.add_argument('--no-clean', '-n', action="store_true", help='Don\'t clean the sysroot to remove recipe output') 1196 parser_reset.add_argument('--no-clean', '-n', action="store_true", help='Don\'t clean the sysroot to remove recipe output')
diff --git a/scripts/lib/devtool/upgrade.py b/scripts/lib/devtool/upgrade.py
index d7fd408..fbffae0 100644
--- a/scripts/lib/devtool/upgrade.py
+++ b/scripts/lib/devtool/upgrade.py
@@ -361,8 +361,8 @@ def upgrade(args, config, basepath, workspace):
361def register_commands(subparsers, context): 361def register_commands(subparsers, context):
362 """Register devtool subcommands from this plugin""" 362 """Register devtool subcommands from this plugin"""
363 parser_upgrade = subparsers.add_parser('upgrade', help='Upgrade an existing recipe', 363 parser_upgrade = subparsers.add_parser('upgrade', help='Upgrade an existing recipe',
364 description='Upgrades an existing recipe to a new upstream version') 364 description='Upgrades an existing recipe to a new upstream version. Puts the upgraded recipe file into the workspace along with any associated files, and extracts the source tree to a specified location (in case patches need rebasing or adding to as a result of the upgrade).')
365 parser_upgrade.add_argument('recipename', help='Name for recipe to extract the source for') 365 parser_upgrade.add_argument('recipename', help='Name of recipe to upgrade (just name - no version, path or extension)')
366 parser_upgrade.add_argument('srctree', help='Path to where to extract the source tree') 366 parser_upgrade.add_argument('srctree', help='Path to where to extract the source tree')
367 parser_upgrade.add_argument('--version', '-V', help='Version to upgrade to (PV)') 367 parser_upgrade.add_argument('--version', '-V', help='Version to upgrade to (PV)')
368 parser_upgrade.add_argument('--srcrev', '-S', help='Source revision to upgrade to (if fetching from an SCM such as git)') 368 parser_upgrade.add_argument('--srcrev', '-S', help='Source revision to upgrade to (if fetching from an SCM such as git)')