summaryrefslogtreecommitdiffstats
path: root/src/doc/rustc-dev-guide/src/bug-fix-procedure.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/doc/rustc-dev-guide/src/bug-fix-procedure.md')
-rw-r--r--src/doc/rustc-dev-guide/src/bug-fix-procedure.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/bug-fix-procedure.md b/src/doc/rustc-dev-guide/src/bug-fix-procedure.md
index 2f5e24716..e69ce48f9 100644
--- a/src/doc/rustc-dev-guide/src/bug-fix-procedure.md
+++ b/src/doc/rustc-dev-guide/src/bug-fix-procedure.md
@@ -1,4 +1,4 @@
-# Rustc Bug Fix Procedure
+# Procedures for Breaking Changes
<!-- toc -->
@@ -169,6 +169,13 @@ there were no errors before.
#### Crater and crates.io
+[Crater] is a bot that will compile all crates.io crates and many
+public github repos with the compiler with your changes. A report will then be
+generated with crates that ceased to compile with or began to compile with your
+changes. Crater runs can take a few days to complete.
+
+[Crater]: ./tests/crater.md
+
We should always do a crater run to assess impact. It is polite and considerate
to at least notify the authors of affected crates the breaking change. If we can
submit PRs to fix the problem, so much the better.