rust-lang / rust-lang/rustc-dev-guide
Integrate Jake's dataflow hackmd into the existing chapter
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
@JakobDegen has very kindly written up a summary of how dataflow works: https://hackmd.io/@2S4Crel_Q9OwC_vamlwXmw/ryqfn_vZn
Unlike the existing chapter (https://rustc-dev-guide.rust-lang.org/mir/dataflow.html#dataflow-analysis), this is a conceptual background, not a guide to how to write a dataflow pass. Both documents are useful and it would be nice to combine them somehow.
cc @rust-lang/wg-mir-opt @camelid, this might be a fun project.
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
Read the existing dataflow chapter at rustc-dev-guide.rust-lang.org/mir/dataflow.html alongside JakobDegen's HackMD summary. Integrate the conceptual background into the chapter while preserving its guidance on writing dataflow passes, with both purposes clearly distinguished and the resulting documentation checked for completeness and coherence.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100