diff options
| author | Adrien Tétar <adri-from-59@hotmail.fr> | 2014-01-11 15:19:38 +0100 |
|---|---|---|
| committer | Adrien Tétar <adri-from-59@hotmail.fr> | 2014-01-11 19:41:31 +0100 |
| commit | a30d61b05a7b11bcc52c2d4988c0a5f7fedce2ff (patch) | |
| tree | f2ff04b7d13f270cd99569a0da8a9976a10f9a7b /doc/complement-bugreport.md | |
| parent | 01794cc993a1f00ca2bc82498b256a88556a4e83 (diff) | |
| download | rust-a30d61b05a7b11bcc52c2d4988c0a5f7fedce2ff.tar.gz rust-a30d61b05a7b11bcc52c2d4988c0a5f7fedce2ff.zip | |
Various READMEs and docs cleanup
Noticeably closes #11428.
Diffstat (limited to 'doc/complement-bugreport.md')
| -rw-r--r-- | doc/complement-bugreport.md | 34 |
1 files changed, 16 insertions, 18 deletions
diff --git a/doc/complement-bugreport.md b/doc/complement-bugreport.md index 15f655ac5e3..d84d720871d 100644 --- a/doc/complement-bugreport.md +++ b/doc/complement-bugreport.md @@ -1,47 +1,45 @@ -% HOWTO submit a RUST bug report +% How to submit a Rust bug report # I think I found a bug in the compiler! - If you see this message: ''error: internal compiler error: unexpected failure'', +If you see this message: `error: internal compiler error: unexpected failure`, 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. - If you see a message about an LLVM assertion failure, then you have also +If you see a message about an LLVM assertion failure, then you have also definitely found a bug in the compiler. In both of these cases, it's not your fault and you should report a bug! - If you see a compiler error message that you think is meant for users to see, +If you see a compiler error message that you think is meant for users to see, 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. -# I don't want to waste the Rust devs' time! How do I know the bug I found isn't a bug that already exists in the issue tracker? +# How do I know the bug I found isn't a bug that already exists in the issue tracker? - If you don't have much time, then don't worry about that. Just submit the bug. -If it's a duplicate, somebody will notice that and close it. No one will laugh -at you, we promise (and if someone did, they would be violating the Rust -[code of conduct](https://github.com/mozilla/rust/wiki/Note-development-policy code of conduct)). +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. - If you have more time, it's very helpful if you can type the text of the error +If you have the time for it, it would be useful to type the text of the error 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, -and it's an open bug, you can comment on that issue and say you ran into it too. -This will encourage devs to fix it. But again, don't let this stop you from +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 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? - It's helpful to include your specific OS (for example: Mac OS X 10.8.3, -Windows 7, Ubuntu 12.0.4) and your hardware architecture (for example: i686, x86_64). +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). It's also helpful to copy/paste the output of re-running the erroneous rustc -commmand 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_begin_unwind`. +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`. -# I submitted a bug, but nobody has commented on it! I'm sad. +# I submitted a bug, but nobody has commented on it! - This is sad, but does happen sometimes, since we're short-staffed. If you +This is sad, but does happen sometimes, since we're short-staffed. If you 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) |
