2014-01-11 08:19:38 -06:00
|
|
|
% How to submit a Rust bug report
|
2013-12-22 20:21:45 -06:00
|
|
|
|
|
|
|
|
# I think I found a bug in the compiler!
|
|
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
If you see this message: `error: internal compiler error: unexpected failure`,
|
2013-12-22 20:21:45 -06:00
|
|
|
then you have definitely found a bug in the compiler. It's also possible that
|
|
|
|
|
your code is not well-typed, but if you saw this message, it's still a bug in
|
|
|
|
|
error reporting.
|
|
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
If you see a message about an LLVM assertion failure, then you have also
|
2013-12-22 20:21:45 -06:00
|
|
|
definitely found a bug in the compiler. In both of these cases, it's not your
|
|
|
|
|
fault and you should report a bug!
|
|
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
If you see a compiler error message that you think is meant for users to see,
|
2013-12-22 20:21:45 -06:00
|
|
|
but it confuses you, *that's a bug too*. If it wasn't clear to you, then it's
|
|
|
|
|
an error message we want to improve, so please report it so that we can try
|
|
|
|
|
to make it better.
|
|
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
# How do I know the bug I found isn't a bug that already exists in the issue tracker?
|
2013-12-22 20:21:45 -06:00
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
If you don't have enough time for a search, then don't worry about that. Just submit
|
|
|
|
|
the bug. If it's a duplicate, somebody will notice that and close it during triage.
|
2013-12-22 20:21:45 -06:00
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
If you have the time for it, it would be useful to type the text of the error
|
2013-12-22 20:21:45 -06:00
|
|
|
message you got [into the issue tracker search box](https://github.com/mozilla/rust/issues)
|
|
|
|
|
to see if there's an existing bug that resembles your problem. If there is,
|
2014-01-11 08:19:38 -06:00
|
|
|
and it's an open bug, you can comment on that issue and say you are also affected.
|
|
|
|
|
This will encourage the devs to fix it. But again, don't let this stop you from
|
2013-12-22 20:21:45 -06:00
|
|
|
submitting a bug. We'd rather have to do the work of closing duplicates than
|
|
|
|
|
miss out on valid bug reports.
|
|
|
|
|
|
|
|
|
|
# What information should I include in a bug report?
|
|
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
It generally helps our diagnosis to include your specific OS (for example: Mac OS X 10.8.3,
|
|
|
|
|
Windows 7, Ubuntu 12.04) and your hardware architecture (for example: i686, x86_64).
|
2013-12-22 20:21:45 -06:00
|
|
|
It's also helpful to copy/paste the output of re-running the erroneous rustc
|
2014-01-11 08:19:38 -06:00
|
|
|
command with the `-v` flag. Finally, if you can run the offending command under gdb,
|
|
|
|
|
pasting a stack trace can be useful; to do so, you will need to set a breakpoint on `rust_fail`.
|
2013-12-22 20:21:45 -06:00
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
# I submitted a bug, but nobody has commented on it!
|
2013-12-22 20:21:45 -06:00
|
|
|
|
2014-01-11 08:19:38 -06:00
|
|
|
This is sad, but does happen sometimes, since we're short-staffed. If you
|
2013-12-22 20:21:45 -06:00
|
|
|
submit a bug and you haven't received a comment on it within 3 business days,
|
|
|
|
|
it's entirely reasonable to either ask on the #rust IRC channel,
|
|
|
|
|
or post on the [rust-dev mailing list](https://mail.mozilla.org/listinfo/rust-dev)
|
|
|
|
|
to ask what the status of the bug is.
|
