riscv-software-src / riscv-software-src/opensbi
"FW_TEXT_ADDR" in docs/firmware/fw.md
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.5k
- Forks
- 712
- PR merge metrics
- No merged PRs in 30d
Description
I am studying opensbi recently, and reading the firmware document.
When I read the docs/firmware/fw.md and its line FW_TEXT_ADDR - Defines the execution address of the OpenSBI firmware. This configuration parameter is mandatory. I try to grep FW_TEXT_ADDR in project, and I only can find it only appears one time. I think the word maybe should be FW_TEXT_START instead of FW_TEXT_ADDR. I found that FW_TEXT_START that appears at many place like config.mk and the it corresponds the word description.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/firmware/fw.md and compare the documented FW_TEXT_ADDR entry with the FW_TEXT_START references found in config.mk and elsewhere in the project. Confirm which name is used by the project, then update the documentation so the parameter name and description match; done means no obsolete name remains in that documentation entry.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100