riscv-software-src / riscv-software-src/opensbi
add HTIF documentation
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.5k
- Forks
- 712
- PR merge metrics
- No merged PRs in 30d
Description
Having a bit of documentation for the HTIF would be good. Currently this still feels a bit like a undocumented useful hack that has been there of quite some time (see e.g. https://github.com/ucb-bar/riscv-sodor/issues/13). What is guaranteed to work actually?
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 by reviewing the HTIF context in the issue and the linked riscv-sodor issue #13. Identify which HTIF behavior is currently relied on and document the guarantees and limitations that can be supported. Done means the supported behavior and what is not guaranteed are clearly recorded.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100