about summary refs log tree commit diff
path: root/src/doc/complement-bugreport.md
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2014-01-28 12:01:57 -0800
committerAlex Crichton <alex@alexcrichton.com>2014-02-02 10:59:14 -0800
commit864b434bfa3fd5b3ea9e38958652ed1abdc24f1d (patch)
tree55d1693b52303c3ae620762f31b616663746a442 /src/doc/complement-bugreport.md
parent2ff16b184950f5b24c3b2a4bf57b6dd7b3fbbe17 (diff)
downloadrust-864b434bfa3fd5b3ea9e38958652ed1abdc24f1d.tar.gz
rust-864b434bfa3fd5b3ea9e38958652ed1abdc24f1d.zip
Move doc/ to src/doc/
We generate documentation into the doc/ directory, so we shouldn't be
intermingling source files with generated files
Diffstat (limited to 'src/doc/complement-bugreport.md')
-rw-r--r--src/doc/complement-bugreport.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/src/doc/complement-bugreport.md b/src/doc/complement-bugreport.md
new file mode 100644
index 00000000000..d84d720871d
--- /dev/null
+++ b/src/doc/complement-bugreport.md
@@ -0,0 +1,46 @@
+% 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`,
+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
+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,
+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.
+
+# How do I know the bug I found isn't a bug that already exists in the issue tracker?
+
+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 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 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 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
+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!
+
+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)
+to ask what the status of the bug is.