Documentation on clock tools seems to be inconsistent.
- Dominant language
- SystemVerilog
- Stars
- 1.7k
- Forks
- 538
- PR merge metrics
- No merged PRs in 30d
Description
Here we have some documentation on some tools for managing the clocks:
https://github.com/aws/aws-fpga/blob/f2/sdk/userspace/fpga_mgmt_tools/README.md#clock-management-commands
However the documentation says that the arguments to fpga-load-clkgen-dynamic are "-S -A -B -C ", but that is not what you get out of the -help output. Similarly for fpga-load-clkgen-recipe.
Contributor guide
Research direction
Open sdk/userspace/fpga_mgmt_tools/README.md at the Clock Management Commands section and run the -help output for fpga-load-clkgen-dynamic and fpga-load-clkgen-recipe. Compare the documented arguments with the help text and update the README so both command descriptions match their actual interfaces.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100