Add unstable book docs for -Zunsound-mir-opts

2020-09-28 22:48:07 -04:00 · 2020-09-28 22:48:07 -04:00 · 63bb51d3ac
commit 63bb51d3ac
parent fc2daaae61
1 changed files with 8 additions and 0 deletions
--- a/src/doc/unstable-book/src/compiler-flags/unsound-mir-opts.md
+++ b/src/doc/unstable-book/src/compiler-flags/unsound-mir-opts.md
@ -0,0 +1,8 @@
+# `unsound-mir-opts`
+
+--------------------
+
+The `-Zunsound-mir-opts` compiler flag enables [MIR optimization passes] which can cause unsound behavior.
+This flag should only be used by MIR optimization tests in the rustc test suite.
+
+[MIR optimization passes]: https://rustc-dev-guide.rust-lang.org/mir/optimizations.html