Document how miri support works

Co-Authored-By: gnzlbg <[email protected]>
rust-lang · Sep 6, 2019 · e0ab2c1 · e0ab2c1
1 parent 70446b5
commit e0ab2c1
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/crates/std_detect/src/detect/mod.rs b/crates/std_detect/src/detect/mod.rs
@@ -65,6 +65,11 @@ mod cache;
 
 cfg_if! {
     if #[cfg(miri)] {
+        // When running under miri all target-features that are not enabled at
+        // compile-time are reported as disabled at run-time.
+        //
+        // For features for which `cfg(target_feature)` returns true,
+        // this run-time detection logic is never called.
         #[path = "os/other.rs"]
         mod os;
     } else if #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] {