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

Document interaction between incremental compilation and diagnostics

Open
#1,090 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The incremental compilation infrastructure has special handling for diagnostics - we capture any diagnostics emitted during query execution, and then re-emit them if the result is loaded from disk.

We should document this handling in the chapter on incremental compilation.

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

Start with the rustc-dev-guide chapter on incremental compilation and locate its discussion of diagnostics. Document that diagnostics emitted during query execution are captured and re-emitted when a result is loaded from disk. Done means the interaction is explained clearly in that chapter.

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
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.