rust-lang / rust-lang/rustc-dev-guide

Describe query recovery

Open
#1,285 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-incr-comp A-query-system E-hard T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

The section on incremental compilation mentions 're-running' a query when one of its inputs is red. We should describe this process ("recovery") in detail. In particular, we should note that this is currently only possible when the query ID can be mapped to a DefPathHash (this is the case for CrateNum, LocalDefId, and DefId).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Find the incremental compilation section that mentions “re-running” a query when an input is red. Read the surrounding explanation, then document query recovery, including that it currently works only when the query ID maps to a DefPathHash, as with CrateNum, LocalDefId, and DefId. Done means the recovery process and this limitation are clearly described.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.