From 115625c8fb77272cb28f02853c461613eea58eb1 Mon Sep 17 00:00:00 2001 From: Claudius Heine Date: Wed, 28 Jun 2017 14:48:44 +0200 Subject: [PATCH] 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 --- kas/build.py | 6 +++++- kas/kas.py | 3 ++- kas/shell.py | 4 +++- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/kas/build.py b/kas/build.py index 0b45005..dea3deb 100644 --- a/kas/build.py +++ b/kas/build.py @@ -46,7 +46,11 @@ class Build: """ 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', help='Config file') diff --git a/kas/kas.py b/kas/kas.py index 2b34b91..5a3fb1b 100644 --- a/kas/kas.py +++ b/kas/kas.py @@ -100,7 +100,8 @@ def kas_get_argparser(): """ 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', version='%(prog)s ' + __version__) diff --git a/kas/shell.py b/kas/shell.py index f007f7f..5fd69eb 100644 --- a/kas/shell.py +++ b/kas/shell.py @@ -44,7 +44,9 @@ class Shell: """ 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', help='Config file')