riscv-software-src / riscof

BSD 3-Clause "New" or "Revised" License
61 stars 39 forks source link

Missing arguments in documentation #55

Open davidharrishmc opened 2 years ago

davidharrishmc commented 2 years ago

The testlist docs suggest using the command

riscof testlist --config=config.ini

https://riscof.readthedocs.io/en/stable/testlist.html

However, --suite and --env are now required arguments as well. The example should be updated to match.

$ riscof testlist --help INFO | ** RISCOF: RISC-V Architectural Test Framework 1.24.1 *** INFO | using riscv_isac version : 0.11.0 INFO | using riscv_config version : 2.13.1 Usage: riscof testlist [OPTIONS]

Generate the test list for the given DUT and suite.

Options: --suite PATH Path to the custom Suite Directory. [required] --env PATH Path to the env directory for the suite. [required] --config PATH The Path to the config file. [Default=./config.ini] --work-dir PATH Path to the work directory. [Default = ./riscof_work] --help Show this message and exit.