gw: Improve help text

scripts/greaseweazle/tools/bandwidth.py

@@ -7,6 +7,8 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Report the available USB bandwidth for the Greaseweazle device."
+
 import sys
 
 from timeit import default_timer as timer
@@ -44,6 +46,7 @@ def main(argv):
     parser = util.ArgumentParser()
     parser.add_argument("device", nargs="?", default="auto",
                         help="serial device")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
 

scripts/greaseweazle/tools/delays.py

@@ -7,6 +7,9 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Display (and optionally modify) Greaseweazle \
+drive-delay parameters."
+
 import sys
 
 from greaseweazle.tools import util
@@ -27,6 +30,7 @@ def main(argv):
                         help="quiescent time until auto deselect (msecs)")
     parser.add_argument("device", nargs="?", default="auto",
                         help="serial device")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
 

scripts/greaseweazle/tools/erase.py

@@ -7,6 +7,8 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Erase a disk."
+
 import sys
 
 from greaseweazle.tools import util
@@ -42,6 +44,7 @@ def main(argv):
                         help="single-sided write")
     parser.add_argument("device", nargs="?", default="auto",
                         help="serial device")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
     args.nr_sides = 1 if args.single_sided else 2

scripts/greaseweazle/tools/pin.py

@@ -7,6 +7,8 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Change the setting of a user-modifiable interface pin."
+
 import sys, argparse
 
 from greaseweazle.tools import util
@@ -27,6 +29,7 @@ def main(argv):
                         help="pin level (H,L)")
     parser.add_argument("device", nargs="?", default="auto",
                         help="serial device")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
 

scripts/greaseweazle/tools/read.py

@@ -7,6 +7,8 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Read a disk to the specified image file."
+
 import sys
 
 from greaseweazle.tools import util
@@ -58,6 +60,7 @@ def main(argv):
     parser.add_argument("file", help="output filename")
     parser.add_argument("device", nargs="?", default="auto",
                         help="serial device")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
     args.nr_sides = 1 if args.single_sided else 2

scripts/greaseweazle/tools/reset.py

@@ -7,6 +7,8 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Reset the Greaseweazle device to power-on default state."
+
 import sys
 
 from greaseweazle.tools import util
@@ -17,6 +19,7 @@ def main(argv):
     parser = util.ArgumentParser()
     parser.add_argument("device", nargs="?", default="auto",
                         help="serial device")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
 

scripts/greaseweazle/tools/update.py

@@ -7,6 +7,8 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Update the Greaseweazle device firmware to current version."
+
 import sys, serial, struct, os
 import crcmod.predefined
 
@@ -93,6 +95,7 @@ def main(argv):
                         help="serial device")
     parser.add_argument("--bootloader", action="store_true",
                         help="update the bootloader (use with caution!)")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
 

scripts/greaseweazle/tools/write.py

@@ -7,6 +7,8 @@
 # This is free and unencumbered software released into the public domain.
 # See the file COPYING for more details, or visit <http://unlicense.org>.
 
+description = "Write a disk from the specified image file."
+
 import sys
 
 from greaseweazle.tools import util
@@ -80,6 +82,7 @@ def main(argv):
     parser.add_argument("file", help="input filename")
     parser.add_argument("device", nargs="?", default="auto",
                         help="serial device")
+    parser.description = description
     parser.prog += ' ' + argv[1]
     args = parser.parse_args(argv[2:])
     args.nr_sides = 1 if args.single_sided else 2

scripts/gw.py

@@ -49,9 +49,11 @@ argv = sys.argv
 
 if len(argv) < 2 or argv[1] not in actions:
     print("Usage: %s [action] [-h] ..." % (argv[0]))
-    print("Actions: ", end="")
-    print(", ".join(str(x) for x in actions))
     print("  -h, --help  Show help message for specified action")
+    print("Actions:")
+    for a in actions:
+        mod = importlib.import_module('greaseweazle.tools.' + a)
+        print('  %-12s%s' % (a, mod.__dict__['description']))
     sys.exit(1)
 
 mod = importlib.import_module('greaseweazle.tools.' + argv[1])