Merge lp:~thomir-deactivatedaccount/autopilot/trunk-add-help into lp:autopilot

[Thomi Richards]

Make the default help text more useful.

Make the default help text more useful.

[Martin Pitt (pitti)]

2 + " can be viewed by passing the '-h' flag to the commamd. For "

Please fix the "command" typo, otherwise LGTM.

review: Needs Fixing

[lp:~thomir-deactivatedaccount/autopilot/trunk-add-help]

342. By Thomi Richards on 2013-09-27

fix typo.

[Martin Pitt (pitti)]

Cheers!

review: Approve

[Christopher Lee (veebers)]

Looks good after typo fix

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:341
http://jenkins.qa.ubuntu.com/job/autopilot-ci/254/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/182
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/182
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-i386-ci/26

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/254/rebuild

review: Approve (continuous-integration)

=== modified file 'autopilot/__init__.py'
--- autopilot/__init__.py	2013-09-18 22:22:23 +0000
+++ autopilot/__init__.py	2013-09-27 04:18:16 +0000
@@ -38,7 +38,13 @@
     """Parse command-line arguments, and return an argparse arguments
     object.
     """
-    parser = ArgumentParser(description="Autopilot test tool.")
+    parser = ArgumentParser(
+        description="Autopilot test tool.",
+        epilog="Each command (run, list, launch etc.) has additional help that"
+        " can be viewed by passing the '-h' flag to the command. For "
+        "example: 'autopilot run -h' displays further help for the "
+        "'run' command."
+    )
     parser.add_argument('-v', '--version', action='version',
                         version=get_version_string(),
                         help="Display autopilot version and exit.")