rust-lang / rust-lang/rustc-dev-guide
improve/fix "codegen" definition
Open
Nobody has claimed this yet.
A-codegen
A-glossary
E-medium
I-confusing
T-compiler
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
In the glossary, codegen is define so
the code to translate MIR into LLVM IR.
I, instead, understood it as steps that actually generates machine code (which llvm is responsible for).
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 by locating the glossary entry for “codegen” in the rustc-dev-guide. Review the current wording against the distinction raised in the issue, then revise the definition so its scope and relationship to LLVM and machine-code generation are unambiguous. Done means the glossary no longer suggests that codegen itself generates machine code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100