Add error explanations for all error codes #32777

GuillaumeGomez · 2016-04-06T19:04:19Z

This is a reopening of #24407 issue. So I took back what was already there and updated it:

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:

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.

Please refer to this RFC when you'll write your error explanation (it can also helps you to start if don't know how to write it).

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

$ ./x.py test src/test/ui -- 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

You can add --jobs 4 to use 4 parallel make processes:

$ ./x.py build --stage 1 --jobs4

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

Progress

cc @steveklabnik

The text was updated successfully, but these errors were encountered:

marti1125 · 2016-04-11T21:26:16Z

I would like to take this =D How to I can start?

GuillaumeGomez · 2016-04-12T17:49:30Z

@marti1125: I guess the first step is to find one of the listed error codes into the rust source code (github search makes it easy) and then try to get the error with rust code. From there, just follow the description of this issue and if you need help, you can always ask (here or on IRC on #rust-docs chan).

Part of rust-lang#32777

@Manishearth

Add E0393 error explanation Part of #32777. r? @Manishearth cc @steveklabnik

@Manishearth

Add E0393 error explanation Part of #32777. r? @Manishearth cc @steveklabnik

timothy-mcroy · 2016-04-29T20:40:35Z

I'm working on E0501.

timothy-mcroy · 2016-05-02T06:38:28Z

I'll open a PR for E0502 tomorrow.

cramertj · 2016-05-02T19:31:39Z

I'll open a PR for E0509 today or tomorrow.

GuillaumeGomez · 2016-05-02T19:55:42Z

@timothy-mcroy, @cramertj: Thanks to both of you! :D

cristianoliveira · 2016-05-03T03:45:17Z

Hey guys. I'll take the E0507. Tomorrow I'm going to work on it (Now is almost 1 am here in Brazil :P)

…r=estebank E0090: Add explanation for error message See rust-lang#32777 $ rustc --explain E0090 The wrong number of lifetimes were supplied. For example: ``` fn foo<'a: 'b, 'b: 'a>() {} fn main() { foo::<'static>(); // error, expected 2 lifetime parameters } ```

CaptainKraft · 2017-04-09T16:29:15Z

In the instructions, it says:

Please refer to this RFC when you'll write your error explanation (it can also helps you to start if don't know how to write it).

and that link to the RFC above leads to rust-lang/rfcs#1567.

Perhaps the link should point to the document explaining the RFC instead of the pull request?

It took me a bit of digging to figure out where that document was.

Edit: A link to the spreadsheet in this thread would be nice for newcomers as well.

marioidival · 2017-07-27T11:52:57Z

@GuillaumeGomez This issue are closed to contribution yet?

GuillaumeGomez · 2017-07-27T15:03:46Z

@marioidival: If you find any error code not having a long error explanation; then it's not. Either add it yourself or open a new issue please.

marioidival · 2017-07-27T15:30:48Z

@GuillaumeGomez The progress show us that much is still missing.

GuillaumeGomez · 2017-07-27T18:28:53Z

I think it's really outdated.

markmmm · 2018-02-18T16:10:53Z

The following appear to already be documented:
E0090
E0230
E0231
E0328
E0399
E0436
E0455
E0466
E0467
E0468
E0469
E0470
E0491

E0414-E0421, E0427 (and others) are commented out - should they be removed from the list?

GuillaumeGomez · 2018-02-18T21:15:13Z

I updated the list. I also checked the removed ones.

markmmm · 2018-05-13T14:54:39Z

Comments after each link are those extracted from either diagnostics.rs or from where the error was raised. My thought is that those would help people identify errors that they may be familiar with and it might help get then resolved :)
Links are github search links.

The following are commented out

E0103 //
E0104 //
E0167 //
E0182 // merged into E0229
E0196 // cannot determine a type for this closure
E0238 // renthesized parameters may only be used with a trait
E0242 //
E0245 // not a trait
E0298 //
E0299 // mismatched types between arms
E0385 // {} in an aliasable location
E0402 // cannot use an outer type parameter in this context
E0406 // merged into 420
E0418 // merged into 532
E0420 // merged into 532
E0471 // constant evaluation error (in pattern)

I couldn't find any reference in git for these (using github search)

E0513
E0521

Listed in src/librustc/diagnostics.rs but not raised anywhere.

E0278

These are the remaining items from the list

Issue	'Raised' in file	comment
E0183	`src/librustc_typeck/diagnostics.rs`
E0203	`src/librustc_typeck/diagnostics.rs`	type parameter has more than one relaxed default bound, and only one is supported
E0208	`src/librustc_typeck/diagnostics.rs`
E0212	`src/librustc_typeck/diagnostics.rs`	cannot extract an associated type from a higher-ranked trait bound
E0224	`src/librustc_typeck/diagnostics.rs`	at least one non-builtin train is required for an object type
E0226	`src/librustc_passes/ast_validation.rs`	only a single explicit lifetime bound is permitted
E0227	`src/librustc_typeck/diagnostics.rs`	ambiguous lifetime bound, explicit lifetime bound required
E0228	`src/librustc_typeck/astconv.rs`	the lifetime bound for this object type cannot be deduced from context; please supply an explicit bound
E0279	`src/librustc/traits/error_reporting.rs`	requirement is not satisfied
E0280	`src/librustc/traits/error_reporting.rs`	requirement is not satisfied
E0284	`src/librustc/traits/error_reporting.rs`	type annotations required: cannot resolve `{}`
E0311	`src/librustc/infer/error_reporting/mod.rs`	"{} may not live long enough", labeled_user_string
E0313	`src/librustc/infer/error_reporting/mod.rs`	lifetime of borrowed pointer outlives lifetime of captured variable
E0314	`src/librustc/infer/error_reporting/note.rs`	closure outlives stack frame
E0315	`src/librustc/infer/error_reporting/note.rs`	cannot invoke closure outside of its lifetime
E0316	`src/librustc/middle/resolve_lifetime.rs`	nested quantification of lifetimes
E0320	`src/librustc/traits/query/dropck_outlives.rs`	recursive overflow during dropck
E0377	`src/librustc_typeck/coherence/builtin.rs`	the trait `CoerceUnsized` may only be implemented for a coercion
E0456	`src/librustc_metadata/creader.rs`	plugin `{}` is not available for triple `{}` (only found {})", name, config::host_triple(), self.sess.opts.target_triple
E0457	`src/librustc_metadata/creader.rs`	plugin `{}` only found in rlib format, but must be available in dylib format"
E0460	`src/librustc_metadata/locator.rs`	found possibly newer version of crate `..` OR found possibly newer version of crate `..` which `{}` depends on
E0461	`src/librustc_metadata/locator.rs`	couldn't find crate `{}` with expected target triple {}{}" OR couldn't find crate `{}` with expected target triple {} which `{}` depends on
E0462	`src/librustc_metadata/locator.rs`	"found staticlib `{}` instead of rlib or dylib{}
E0464	`src/librustc_metadata/locator.rs`	multiple matching crates for `{}`
E0465	`src/librustc_metadata/locator.rs`	multiple {} candidates for `{}` found", flavor, self.crate_name
E0472	`src/librustc_passes/ast_validation.rs`	"asm! is unsupported on this target"
E0473	`src/librustc/infer/error_reporting/note.rs`	dereference of reference outside its lifetime
E0474	`src/librustc/infer/error_reporting/note.rs`	captured variable `..` does not outlive the enclosing closure
E0475	`src/librustc/infer/error_reporting/note.rs`	index of slice outside its lifetime
E0476	`src/librustc/infer/error_reporting/note.rs`	lifetime of the source pointer does not outlive lifetime bound...
E0477	`src/librustc/infer/error_reporting/note.rs`	the type `..` does not fulfill the required lifetime...
E0479	`src/librustc/infer/error_reporting/note.rs`	the type `{}` (provided as the value of a type parameter) is not valid at this point
E0480	`src/librustc/infer/error_reporting/note.rs`	lifetime of method receiver does not outlive the method call
E0481	`src/librustc/infer/error_reporting/note.rs`	lifetime of function argument does not outlive the function call
E0482	`src/librustc/infer/error_reporting/note.rs`	lifetime of return value does not outlive the function call
E0483	`src/librustc/infer/error_reporting/note.rs`	lifetime of operand does not outlive the operation
E0484	`src/librustc/infer/error_reporting/note.rs`	reference is not valid at the time of borrow
E0485	`src/librustc/infer/error_reporting/note.rs`	automatically reference is not valid at the time of borrow
E0486	`src/librustc/infer/error_reporting/note.rs`	type of expression contains references that are not valid during the expression: `{}`
E0487	`src/librustc/infer/error_reporting/note.rs`	unsafe use of destructor: destructor might be called while references are dead
E0488	`src/librustc/infer/error_reporting/note.rs`	lifetime of variable does not enclose its declaration
E0489	`src/librustc/infer/error_reporting/note.rs`	type/lifetime parameter not in scope here
E0490	`src/librustc/infer/error_reporting/note.rs`	a value of type `{}` is borrowed for too long
E0495	`src/librustc/infer/error_reporting/mod.rs`	cannot infer an appropriate lifetime due to conflicting requirements
E0498	`src/librustc_plugin/load.rs`	malformed plugin attribute
E0514	`src/librustc_metadata/locator.rs`	metadata version mismatch
E0523	`src/librustc_metadata/creader.rs`	found two different crates with name `{}` that are not distinguished by differing `-C metadata`. This will result in symbol conflicts between the two.

Havvy · 2018-06-10T07:04:48Z

The following are not listed at all, but are missing:

0523, 0524, 0526, 0531, 0533, 0538-0551, 0553, 0555, 0556, 0561. 0563, 0564, 0566-0568, 0573-0578, 0584, 0592, 0594, 0598, 0613, 0623, 0625, 0627-0632, 0634-0637, 0640-0642, 0645, 0648-0657, 0660-0688, 0693, 0694, 0696-0907 (???? at this last range)

GuillaumeGomez · 2018-06-10T11:01:45Z

There is a 907????????

GuillaumeGomez · 2018-06-10T11:02:57Z

I'm fixing those codes...

EDIT: Done in #51475.

twe4ked · 2019-04-23T09:41:14Z

Add extended information for E0594 in #60193.

oli-obk · 2019-05-24T18:16:02Z

@GuillaumeGomez there are new error codes that do not have boxes yet

GuillaumeGomez · 2019-05-24T18:37:36Z

I think this issue is completely out of date since a moment... Should we open a new one instead?

Manishearth · 2019-05-24T18:47:06Z

Yeah, go for it -Manish Goregaokar

…

On Fri, May 24, 2019 at 11:38 AM Guillaume Gomez ***@***.***> wrote: I think this issue is completely out of date since a moment... Should we open a new one instead? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#32777?email_source=notifications&email_token=AAMK6SGW7NKBMJ35UP6LTRLPXAY4DA5CNFSM4CAFTAD2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODWGIFXQ#issuecomment-495747806>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAMK6SDJIZHGY7NYBW4MBJLPXAY4DANCNFSM4CAFTADQ> .

GuillaumeGomez · 2019-05-24T20:18:54Z

Ok!

GuillaumeGomez · 2019-05-24T20:46:49Z

Closing in favor of #61137.

GuillaumeGomez added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Apr 6, 2016

GuillaumeGomez assigned GuillaumeGomez and unassigned GuillaumeGomez Apr 6, 2016

GuillaumeGomez added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. and removed E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. labels Apr 8, 2016

GuillaumeGomez mentioned this issue Apr 11, 2016

Add E0520 error code #32878

Closed

wesleywiser mentioned this issue Apr 12, 2016

Add error description for E0436 #32899

Closed

GuillaumeGomez self-assigned this Apr 12, 2016

GuillaumeGomez mentioned this issue Apr 15, 2016

Add E0393 error explanation #32989

Merged

wesleywiser added a commit to wesleywiser/rust that referenced this issue Apr 20, 2016

Add error description for E0436

4c2409c

Part of rust-lang#32777

bors added a commit that referenced this issue Apr 24, 2016

Auto merge of #32989 - GuillaumeGomez:e0393, r=Manishearth

a502229

Add E0393 error explanation Part of #32777. r? @Manishearth cc @steveklabnik

bors added a commit that referenced this issue Apr 26, 2016

Auto merge of #32989 - GuillaumeGomez:e0393, r=Manishearth

03bef4c

Add E0393 error explanation Part of #32777. r? @Manishearth cc @steveklabnik

timothy-mcroy mentioned this issue Apr 27, 2016

Explain E0434 #33229

Merged

timothy-mcroy pushed a commit to timothy-mcroy/rust that referenced this issue Apr 28, 2016

Add detailed error message for E0434 rust-lang#32777

0cfb5a0

timothy-mcroy mentioned this issue Apr 30, 2016

Add detailed error explanation for E0501 #33294

Merged

timothy-mcroy mentioned this issue May 2, 2016

Add error explanation for E0502 #33353

Merged

steveklabnik added the P-medium Medium priority label Mar 22, 2017

steveklabnik removed the A-docs label Mar 24, 2017

kennytm mentioned this issue Apr 11, 2017

unsatisfyable HKL error message prints broken bound (for<'b> 'b : ) #35180

Open

Susurrus mentioned this issue May 25, 2017

Add error codes for all errors #42229

Closed

7 tasks

GuillaumeGomez closed this as completed Jul 13, 2017

GuillaumeGomez reopened this May 13, 2018

XAMPPRocky added the C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC label May 14, 2018

zackmdavis mentioned this issue Oct 31, 2018

Error 0212 is missing from the error index #55523

Closed

oli-obk mentioned this issue May 24, 2019

No docs for error code E0280 #50028

Closed

GuillaumeGomez mentioned this issue May 24, 2019

Add missing long error code explanations #61137

Closed

100 tasks

GuillaumeGomez closed this as completed May 24, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add error explanations for all error codes #32777

Add error explanations for all error codes #32777

GuillaumeGomez commented Apr 6, 2016 •

edited

Loading

marti1125 commented Apr 11, 2016

GuillaumeGomez commented Apr 12, 2016

timothy-mcroy commented Apr 29, 2016

timothy-mcroy commented May 2, 2016

cramertj commented May 2, 2016

GuillaumeGomez commented May 2, 2016

cristianoliveira commented May 3, 2016

CaptainKraft commented Apr 9, 2017 •

edited

Loading

marioidival commented Jul 27, 2017

GuillaumeGomez commented Jul 27, 2017

marioidival commented Jul 27, 2017

GuillaumeGomez commented Jul 27, 2017

markmmm commented Feb 18, 2018 •

edited

Loading

GuillaumeGomez commented Feb 18, 2018

markmmm commented May 13, 2018

Havvy commented Jun 10, 2018

GuillaumeGomez commented Jun 10, 2018

GuillaumeGomez commented Jun 10, 2018 •

edited

Loading

twe4ked commented Apr 23, 2019

oli-obk commented May 24, 2019

GuillaumeGomez commented May 24, 2019

Manishearth commented May 24, 2019 via email

GuillaumeGomez commented May 24, 2019

GuillaumeGomez commented May 24, 2019

Add error explanations for all error codes #32777

Add error explanations for all error codes #32777

Comments

GuillaumeGomez commented Apr 6, 2016 • edited Loading

How to add an error explanation

Progress

marti1125 commented Apr 11, 2016

GuillaumeGomez commented Apr 12, 2016

timothy-mcroy commented Apr 29, 2016

timothy-mcroy commented May 2, 2016

cramertj commented May 2, 2016

GuillaumeGomez commented May 2, 2016

cristianoliveira commented May 3, 2016

CaptainKraft commented Apr 9, 2017 • edited Loading

marioidival commented Jul 27, 2017

GuillaumeGomez commented Jul 27, 2017

marioidival commented Jul 27, 2017

GuillaumeGomez commented Jul 27, 2017

markmmm commented Feb 18, 2018 • edited Loading

GuillaumeGomez commented Feb 18, 2018

markmmm commented May 13, 2018

Havvy commented Jun 10, 2018

GuillaumeGomez commented Jun 10, 2018

GuillaumeGomez commented Jun 10, 2018 • edited Loading

twe4ked commented Apr 23, 2019

oli-obk commented May 24, 2019

GuillaumeGomez commented May 24, 2019

Manishearth commented May 24, 2019 via email

GuillaumeGomez commented May 24, 2019

GuillaumeGomez commented May 24, 2019

GuillaumeGomez commented Apr 6, 2016 •

edited

Loading

CaptainKraft commented Apr 9, 2017 •

edited

Loading

markmmm commented Feb 18, 2018 •

edited

Loading

GuillaumeGomez commented Jun 10, 2018 •

edited

Loading