mbed: config: print detailed help in subcommand

[naveenkaje]

Print detailed usage when unsupported arguments are supplied with mbed config subcommand

[naveenkaje]

Previous and new behavior details

    Before this change
    $mbed config -random unsupported
    [mbed] Working path "/home/navkaj01/code/mbed-os-example-blinky" (program)
    [mbed] No default d set in program "mbed-os-example-blinky"

    With this change
    $ mbed config -random unsupported
    [mbed] Working path "/home/navkaj01/code/mbed-os-example-blinky" (program)
    [mbed] No default unsupported set in program "mbed-os-example-blinky"
    usage: mbed config [-h] [-G] [-U] [-L] [-v] [-vv] [var] [value]

    Gets, sets or unsets mbed tool configuration options.
    Options can be global (via the --global switch) or local (per program)
    Global options are always overridden by local/program options.
    Currently supported options: target, toolchain, protocol, depth, cache, profile

    positional arguments:
      var                  Variable name. E.g. "target", "toolchain", "protocol"
      value                Value. Will show the currently set default value for a
                           variable if not specified.

    optional arguments:
      -h, --help           show this help message and exit
      -G, --global         Use global settings, not local
      -U, --unset          Unset the specified variable.
      -L, --list           List mbed tool configuration. Not to be confused with
                           compile configuration, e.g. "mbed compile --config".
      -v, --verbose        Verbose diagnostic output
      -vv, --very_verbose  Very verbose diagnostic output

    Before
    $ mbed config -random
    [mbed] Working path "/home/navkaj01/code/mbed-os-example-blinky" (program)
    usage: mbed config [-h] [-G] [-U] [-L] [-v] [-vv] [var] [value]
    mbed config: error: too few arguments

    With this change
    $ mbed config -random 
    [mbed] Working path "/home/navkaj01/code/mbed-os-example-blinky" (program)
    usage: mbed config [-h] [-G] [-U] [-L] [-v] [-vv] [var] [value]

   Gets, sets or unsets mbed tool configuration options.
   Options can be global (via the --global switch) or local (per program)
   Global options are always overridden by local/program options.
   Currently supported options: target, toolchain, protocol, depth, cache, profile

   positional arguments:
    var                  Variable name. E.g. "target", "toolchain", "protocol"
    value                Value. Will show the currently set default value for a
                       variable if not specified.

   optional arguments:
    -h, --help           show this help message and exit
    -G, --global         Use global settings, not local
    -U, --unset          Unset the specified variable.
    -L, --list           List mbed tool configuration. Not to be confused with
                       compile configuration, e.g. "mbed compile --config".
    -v, --verbose        Verbose diagnostic output
    -vv, --very_verbose  Very verbose diagnostic output
   usage: mbed config [-h] [-G] [-U] [-L] [-v] [-vv] [var] [value]
   mbed config: error: too few arguments

[naveenkaje]

perhaps we should exit() here?

[naveenkaje]

@bridadan @theotherjimmy Please review

[bridadan]

The supplied output seems really verbose. It's pretty easy to loose the actual error that occurred.

Is the concern that the current error output isn't helpful/accurate when a variable that has no effect is supplied to the mbed config command?

[TacoGrandeTX]

We also wanted to fix this list:

Currently supported options: target, toolchain, protocol, depth, cache, profile

Tool paths are supported... and @theotherjimmy also mentioned colors

I think the other goal was to reject variables that weren't legit.

[bridadan]

So just to be extra clear, fix the documentation about values are able to configured, and also error if an unsupported value is supplied?

[TacoGrandeTX]

@bridadan Yes - sorry for the confusion! @theotherjimmy corrected the wording of the Issue here: #862 (comment)

[naveenkaje]

Old

$ mbed config -unsupported
usage: mbed config [-h] [-G] [-U] [-L] [-v] [-vv] [var] [value]
mbed config: error: too few arguments
$ mbed config -unsupported blah
[mbed] No default blah set in program "mbed-os-example-blinky"

New

$ mbed config -unsupported
[mbed] Working path "/home/navkaj01/code/mbed-os-example-blinky" (program)
usage: mbed config [-h] [-G] [-U] [-L] [-v] [-vv] [var] [value]
mbed config: error: Too few arguments. Run with -h for detailed help
---

$ mbed config -unsupported blah
[mbed] Working path "/home/navkaj01/code/mbed-os-example-blinky" (program)
[mbed] No default blah set in program "mbed-os-example-blinky"
[mbed] ERROR: run with -h for detailed help
---

[naveenkaje]

Todo: colors

[bridadan]

@naveenkaje colors can probably be in a separate PRs right? I don't think we do colors at all in mbed cli.

[naveenkaje]

@naveenkaje colors can probably be in a separate PRs right? I don't think we do colors at all in mbed cli.

Sounds good to me

[theotherjimmy]

@bridadan I think you may have misinterpreted "colors". @naveenkaje Is probably talking about adding the COLOR config option to the list. I think that would be part of this PR.