]> git-server-git.apps.pok.os.sepia.ceph.com Git - teuthology.git/commitdiff
made help more readable
authortamil <tamil.muthamizhan@inktank.com>
Thu, 12 Sep 2013 22:03:10 +0000 (15:03 -0700)
committertamil <tamil.muthamizhan@inktank.com>
Thu, 12 Sep 2013 22:03:10 +0000 (15:03 -0700)
Signed-off-by: tamil <tamil.muthamizhan@inktank.com>
teuthology/lock.py
teuthology/nuke.py

index 2869196aa35eb36d24c28d87fa90386dace20982..7f3b0fcfa03d389d04476cc1019b958e9036901f 100644 (file)
@@ -9,6 +9,7 @@ import collections
 import tempfile
 import os
 import time
+import textwrap
 
 from argparse import RawTextHelpFormatter
 from teuthology import lockstatus as ls
@@ -112,9 +113,18 @@ def canonicalize_hostname(s):
     return s
 
 def main():
-    parser = argparse.ArgumentParser(description='Lock, unlock, or query lock status of machines',
-epilog='Examples: \n teuthology-lock --summary \n teuthology-lock --lock-many 1 --machine-type vps \n teuthology-lock --lock -t target.yaml \n teuthology-lock --list-targets plana01 \n teuthology-lock --list --brief --owner user@host \n teuthology-lock --update --status down --desc testing plana01',
-formatter_class=RawTextHelpFormatter)
+    parser = argparse.ArgumentParser(
+        description='Lock, unlock, or query lock status of machines',
+        epilog=textwrap.dedent('''
+            Examples:
+            teuthology-lock --summary
+            teuthology-lock --lock-many 1 --machine-type vps
+            teuthology-lock --lock -t target.yaml
+            teuthology-lock --list-targets plana01
+            teuthology-lock --list --brief --owner user@host
+            teuthology-lock --update --status down --desc testing plana01
+        '''),
+        formatter_class=RawTextHelpFormatter)
     parser.add_argument(
         '-v', '--verbose',
         action='store_true',
@@ -194,7 +204,7 @@ formatter_class=RawTextHelpFormatter)
     parser.add_argument(
         '--machine-type',
         default=None,
-        help='Type of machine to lock.It could be mira or plana or burnupi or vps or saya or tala',
+        help='Type of machine to lock, valid choices: mira | plana | burnupi | vps | saya | tala',
         )
     parser.add_argument(
         '--status',
index 6659a6870cc8342508ecd9db33523f7ab30ca24e..626a550afcc0bf3aede995dc615d984ab6524eb8 100644 (file)
@@ -1,14 +1,20 @@
 import argparse
 import yaml
+import textwrap
 from argparse import RawTextHelpFormatter
 
 def parse_args():
     from teuthology.run import config_file
     from teuthology.run import MergeConfig
 
-    parser = argparse.ArgumentParser(description='Reset test machines',
-epilog='Examples: \n teuthology-nuke -t target.yaml --unlock --owner user@host \n teuthology-nuke -t target.yaml --pid 1234 --unlock --owner user@host \n',
-formatter_class=RawTextHelpFormatter)
+    parser = argparse.ArgumentParser(
+        description='Reset test machines',
+        epilog=textwrap.dedent('''
+            Examples:
+            teuthology-nuke -t target.yaml --unlock --owner user@host
+            teuthology-nuke -t target.yaml --pid 1234 --unlock --owner user@host \n
+            '''),
+        formatter_class=RawTextHelpFormatter)
     parser.add_argument(
         '-v', '--verbose',
         action='store_true', default=None,