Skip to content

Expand help text for args

Anders Lindh Olsson requested to merge improve_help into master

The help text for iocsh does not show the default option for valgrind:

$ iocsh -h
usage: IOC shell for e3 [-h] [-V] [-r MODULE] [-c COMMAND] [-d DATABASE]
                        [-l PATH] [-rt | -dg [ARGUMENT] | -dv [ARGUMENT] |
                        --debug] [-i]
                        [file]

ESS EPICS environment (e3) wrapper for softIocPVA

positional arguments:
  file                  path to startup script

optional arguments:
...
  -dg [ARGUMENT], --gdb [ARGUMENT]
                        run with gdb
  -dv [ARGUMENT], --valgrind [ARGUMENT]
                        run with valgrind
...

This is now changed to

$ iocsh -h
usage: IOC shell for e3 [-h] [-V] [-r MODULE] [-c COMMAND] [-d DATABASE]
                        [-l PATH] [-rt | -dg [ARGUMENT] | -dv [ARGUMENT] |
                        --debug] [-i]
                        [file]

ESS EPICS environment (e3) wrapper for softIocPVA

positional arguments:
  file                  path to startup script

optional arguments:
...
  -dg [ARGUMENT], --gdb [ARGUMENT]
                        run with gdb, optionally with arguments
  -dv [ARGUMENT], --valgrind [ARGUMENT]
                        run with valgrind, optionally with arguments (default
                        '--leak-check=full')
...

Merge request reports