Added and fixed documentation for kas command line

Documentation for the 'build' and 'shell' command line were missing.
Also fixed kas command line documentation mentioning 'ebs-yocto'.

Signed-off-by: Claudius Heine <ch@denx.de>
This commit is contained in:
Claudius Heine 2017-06-28 14:48:44 +02:00 committed by Daniel Wagner
parent c1f2902b21
commit 115625c8fb
3 changed files with 10 additions and 3 deletions

View File

@ -46,7 +46,11 @@ class Build:
""" """
Returns an a parser for the build plugin Returns an a parser for the build plugin
""" """
bld_psr = parser.add_parser('build') bld_psr = parser.add_parser('build',
help='Checks out all necessary '
'repositories and builds using '
'bitbake as specificed in the '
'configuration file.')
bld_psr.add_argument('config', bld_psr.add_argument('config',
help='Config file') help='Config file')

View File

@ -100,7 +100,8 @@ def kas_get_argparser():
""" """
Creates a argparser for kas with all plugins. Creates a argparser for kas with all plugins.
""" """
parser = argparse.ArgumentParser(description='Steer ebs-yocto builds') parser = argparse.ArgumentParser(description='kas - setup tool for '
'bitbake based project')
parser.add_argument('--version', action='version', parser.add_argument('--version', action='version',
version='%(prog)s ' + __version__) version='%(prog)s ' + __version__)

View File

@ -44,7 +44,9 @@ class Shell:
""" """
Returns a parser for the shell plugin Returns a parser for the shell plugin
""" """
sh_prs = parser.add_parser('shell') sh_prs = parser.add_parser('shell',
help='Run a shell in the build '
'environment.')
sh_prs.add_argument('config', sh_prs.add_argument('config',
help='Config file') help='Config file')