Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing --fw-tar option from --help menu. #9

Open
hmohiuddinTT opened this issue Mar 21, 2024 · 4 comments
Open

Missing --fw-tar option from --help menu. #9

hmohiuddinTT opened this issue Mar 21, 2024 · 4 comments
Labels
bug Something isn't working enhancement New feature or request internal_report

Comments

@hmohiuddinTT
Copy link

Missing the --fw-tar option from the --help menu.

image

Related to: https://github.com/tenstorrent/tt-flash/blob/9808227dc84ec5e0d5a81d8860b04f9e31338159/tt_flash/main.py#L70C1-L71C1

@hmohiuddinTT hmohiuddinTT added documentation Improvements or additions to documentation enhancement New feature or request and removed documentation Improvements or additions to documentation labels Mar 29, 2024
@warthog9
Copy link
Member

That's odd it looks like it should be there already:

https://github.com/tenstorrent/tt-flash/blame/bd53bc043189baa8324b8ffbb9454ee3650c54b6/tt_flash/main.py#L70

When you get a chance can you re-test with latest?

@warthog9
Copy link
Member

(venv) root@orko:~# tt-flash --help
usage: tt-flash [-h] [-v] [--force] [--fw-tar FW_TAR]

options:
-h, --help show this help message and exit
-v, --version show program's version number and exit
--force Force update the ROM
--fw-tar FW_TAR Path to the firmware tarball
(venv) root@orko:~#

I think this is already resolved so going to close this

@warthog9 warthog9 reopened this Apr 25, 2024
@warthog9
Copy link
Member

Ok re-opening as I figured out what's going on, and this is valid. The help text EXISTS, except when you run the top level tt-flash --help or tt-flash without anything it shows the options for tt-flash but DOES NOT show that the commands exist. So we need a way to get what commands are available into the top level help more obviously

@hmohiuddinTT hmohiuddinTT added the bug Something isn't working label Jul 16, 2024
@afaerber
Copy link
Contributor

As visible at the bottom of the first screenshot, it does show the commands:

command:
  {flash}

What's missing is a sentence to the effect of, "See tt-flash {command} --help for further command-specific help."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request internal_report
Projects
None yet
Development

No branches or pull requests

3 participants