runtimeverification / runtimeverification/llvm-backend
Improve LLVM backend documentation
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 43
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the LLVM backend code is only really documented in-source; this means that getting up to speed with it can be a bit opaque. We have nice documentation for the pattern-matching algorithm part of the compiler, but it would be good to write up some high-level documentation for how each step of the backend works. This could potentially take place alongside some code cleanup.
Work done:
- #650
Contributor guide
No contributing guide indexed for this repository
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 matching/README.md and the LLVM backend source to map the backend's major steps and their relationships. Document the high-level flow of each step, using the existing pattern-matching documentation as a reference; completion means a newcomer can understand how the backend works without relying only on in-source comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100