Add error explanations for all error codes (tracking issue).

[michaelsproul]

This is a metabug for rustc --explain error descriptions.

All the errors in need of descriptions are listed in this spreadsheet. If you'd like to help out, comment with the bunch of errors you'd like to tackle, and list yourself as assigned on the spreadsheet!

Choosing a few errors in the same file is probably a good way to start.

How to add an error explanation

Error explanations live in src/librustc*/diagnostics.rs. To add a new explanation you have to delete the error from the register_diagnostics! invocation and add it to the register_long_diagnostics! invocation, along with the explanation. The format for the explanation is 80 characters per line, with a newline at the very start and end of the string. Including code examples is encouraged, with full markdown formatting (single-tick for inline, triple for blocks). Copy the format of the existing errors and you should be good!

Once you've added an explanation you can test it out by compiling and running stage1 as follows:

$ make rustc-stage1
$ export PATH=x86_64-unknown-linux-gnu/stage1/bin:$PATH
$ export LD_LIBRARY_PATH=x86_64-unknown-linux-gnu/stage1/lib:$LD_LIBRARY_PATH
$ rustc --explain EXXXX

If you want to see how it renders as HTML you'll have to build the error index, which requires stage2:

$ make doc/error-index.html

You can add -j 4 to use 4 parallel make processes.

Once you're happy with the result, submit a pull request and we'll review it.

Progress

We're tracking progress with a shared spreadsheet. If you'd like to write an error message, put your name down for one of the unassigned errors.

Rust Error Diagnostic Spreadsheet (click me!)

As you complete error descriptions it would also be great if you could mark the errors as "merged" on the spreadsheet 😄

[lifthrasiir]

This is going to be a good thing, but do not forget to add the following lists:

• https://github.com/rust-lang/rust/blob/master/src/librustc_resolve/diagnostics.rs
• https://github.com/rust-lang/rust/blob/master/src/librustc_typeck/diagnostics.rs
• https://github.com/rust-lang/rust/blob/master/src/librustc_borrowck/diagnostics.rs

[michaelsproul]

Thanks! I wasn't aware of those!

[lambda-fairy]

I'll take E0152 through E0170, thanks!

Question: Should I squash all the additions into a single commit, or keep them separate?

[GuillaumeGomez]

I'll take E0009 (a little start to begin).

[michaelsproul]

@lfairy: Either is fine. If there are logical slabs of messages that could also work well.

@GuillaumeGomez: Sounds good 😄

[michaelsproul]

Thanks!

[ruuda]

I’ll take E0297 through E0302 (the ones in check_match). Edit: I’ll take E0162 and E0165 as well. I have not been able to come up with an example that causes 298, 299 or 300. Does anybody have a snippet that causes these? Anything I try fails with a type mismatch. Similarly, I have not been able to produce 158 yet, but there is an unnumbered error with a similar message. (Maybe those should be reconciled?)

[lambda-fairy]

@ruud-v-a I'm already working on 158/162/165 (see my comment above)

[michaelsproul]

Sorry Chris, I only just noticed this now... If you have anything to add to Ruud's descriptions go ahead!

I was hoping I could transform the list into a more complete one, but my script is somewhat broken so I'm looking into better ways to extract error information (uniqueness checking, finding errors without descriptions, HTML output). For now I've marked who's working on what in the current list.

[michaelsproul]

I just did E0296.

[michaelsproul]

I'll also take the loop ones, E0267 and E0268.

[lambda-fairy]

@michaelsproul No worries :)

I'll take E0306 and E0307.