Help text on Windows misleading

[ReinhardKeil]

Describe the bug
On windows the help message for -R option is somewhat confusing

Instead of:

  -R, --pack-root string   Specifies pack root folder. Defaults to CMSIS_PACK_ROOT environment variable (default "C:\\Users\\reikei01\\AppData\\Local\\Arm\\Packs")

It should be:

  -R, --pack-root string   Specifies pack root folder. Defaults to CMSIS_PACK_ROOT environment variable (default "C:\Users\reikei01\AppData\Local\Arm\Packs")

To Reproduce
Steps to reproduce the behavior:

1. Run the cpackget on Windows 10 with the following command line

cpackget add -h

Note that this issue might exist in other places too.

---

With the command cpackget index -h (on Windows) there is another misleading output.

Instead of:

Updates the public index in CMSIS_PACK_ROOT/.Web/index.pidx using the file specified by the given url.

it could be

Updates the public index in %CMSIS_PACK_ROOT%/.Web/index.pidx using the file specified by the given url.

I believe the %CMSIS_PACK_ROOT% notation also works on Linux

[chaws]

-R, --pack-root string Specifies pack root folder. Defaults to CMSIS_PACK_ROOT environment variable (default "C:\\Users\\reikei01\\AppData\\Local\\Arm\\Packs")

The path is being escaped. I'll look into getting the path in this and other places un-escaped as well. The same for the environment variable notation.

[lud0v1c]

Tested several different shells in Windows and ways to replace the printed path, but I think it's related to the module used for the commands (cobra). Opened an issue there to get some feedback on it, as it only seems to happen in Windows.

[lud0v1c]

As per the modules contributor's response, it seems possible to implement a custom type of Flag that would format the Usage text in a different manner, not escaping the backslashes. Will look into how feasible it is to implement it.

[lud0v1c]

Closing this for now, subscribed to the Cobra issue in case any relevant updates or the pending PR is pushed as not to add such additional complexity (the first part is already done ).