about summary refs log tree commit diff
diff options
context:
space:
mode:
authorWesley Wiser <wwiser@gmail.com>2020-09-28 22:48:07 -0400
committerGitHub <noreply@github.com>2020-09-28 22:48:07 -0400
commit63bb51d3ac3ec015d914e2b0792b4d5aa6e8e4a5 (patch)
tree48747acb955c64123ba97291529880ee1ece0c25
parentfc2daaae610b5515438b551a2f3706196a997f35 (diff)
downloadrust-63bb51d3ac3ec015d914e2b0792b4d5aa6e8e4a5.tar.gz
rust-63bb51d3ac3ec015d914e2b0792b4d5aa6e8e4a5.zip
Add unstable book docs for `-Zunsound-mir-opts`
-rw-r--r--src/doc/unstable-book/src/compiler-flags/unsound-mir-opts.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/doc/unstable-book/src/compiler-flags/unsound-mir-opts.md b/src/doc/unstable-book/src/compiler-flags/unsound-mir-opts.md
new file mode 100644
index 00000000000..8e46e227c25
--- /dev/null
+++ 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