• Daniel Latypov's avatar
    kunit: tool: more descriptive metavars/--help output · baa33315
    Daniel Latypov authored
    Before, our help output contained lines like
      --kconfig_add KCONFIG_ADD
      --qemu_config qemu_config
      --jobs jobs
    
    They're not very helpful.
    
    The former kind come from the automatic 'metavar' we get from argparse,
    the uppercase version of the flag name.
    The latter are where we manually specified metavar as the flag name.
    
    After:
      --build_dir DIR
      --make_options X=Y
      --kunitconfig PATH
      --kconfig_add CONFIG_X=Y
      --arch ARCH
      --cross_compile PREFIX
      --qemu_config FILE
      --jobs N
      --timeout SECONDS
      --raw_output [{all,kunit}]
      --json [FILE]
    
    This patch tries to make the code more clear by specifying the _type_ of
    input we expect, e.g. --build_dir is a DIR, --qemu_config is a FILE.
    I also switched it to uppercase since it looked more clearly like
    placeholder text that way.
    
    This patch also changes --raw_output to specify `choices` to make it
    more clear what the options are, and this way argparse can validate it
    for us, as shown by the added test case.
    Signed-off-by: default avatarDaniel Latypov <dlatypov@google.com>
    Reviewed-by: default avatarDavid Gow <davidgow@google.com>
    Reviewed-by: default avatarBrendan Higgins <brendanhiggins@google.com>
    Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
    baa33315
kunit.py 17.5 KB