Add a warning that Miri does not check for data-races.

[rust.git] / README.md

diff --git a/README.md b/README.md
index a86de4a5551900819a1cb9023a1afa939a8aca39..fb981a71f0e4d5836d39154c18da3916304d343b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -47,7 +47,9 @@ in your program, and cannot run all programs:
 * Miri runs the program as a platform-independent interpreter, so the program
   has no access to most platform-specific APIs or FFI. A few APIs have been
   implemented (such as printing to stdout) but most have not: for example, Miri
-  currently does not support concurrency, or SIMD, or networking.
+  currently does not support SIMD or networking.
+* Miri currently does not check for data-races and other concurrency related
+  issues.
 
 [rust]: https://www.rust-lang.org/
 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md
@@ -127,16 +129,11 @@ MIRI_NIGHTLY=nightly-$(curl -s https://rust-lang.github.io/rustup-components-his
 echo "Installing latest nightly with Miri: $MIRI_NIGHTLY"
 rustup set profile minimal
 rustup default "$MIRI_NIGHTLY"
-
 rustup component add miri
-cargo miri setup
 
 cargo miri test
 ```
 
-We use `cargo miri setup` to avoid getting interactive questions about the extra
-setup needed for Miri.
-
 ### Common Problems
 
 When using the above instructions, you may encounter a number of confusing compiler
@@ -274,6 +271,7 @@ Definite bugs found:
 * [`Vec`](https://github.com/rust-lang/rust/issues/69770) and [`BTreeMap`](https://github.com/rust-lang/rust/issues/69769) leaking memory under some (panicky) conditions
 * [Memory leak in `beef`](https://github.com/maciejhirsz/beef/issues/12)
 * [Invalid use of undefined memory in `EbrCell`](https://github.com/Firstyear/concread/commit/b15be53b6ec076acb295a5c0483cdb4bf9be838f#diff-6282b2fc8e98bd089a1f0c86f648157cR229)
+* [Unaligned pointer access in TiKV](https://github.com/tikv/tikv/issues/7613)
 
 Violations of [Stacked Borrows] found that are likely bugs (but Stacked Borrows is currently just an experiment):
 
@@ -284,6 +282,8 @@ Violations of [Stacked Borrows] found that are likely bugs (but Stacked Borrows
 * [`align_to_mut` violating uniqueness of mutable references](https://github.com/rust-lang/rust/issues/68549)
 * [Aliasing mutable references in `sized-chunks`](https://github.com/bodil/sized-chunks/issues/8)
 * [`String::push_str` invalidating existing references into the string](https://github.com/rust-lang/rust/issues/70301)
+* [`ryu` using raw pointers outside their valid memory area](https://github.com/dtolnay/ryu/issues/24)
+* [ink! creating overlapping mutable references](https://github.com/rust-lang/miri/issues/1364)
 
 ## License