From: Martin Habovštiak <martin.habovstiak@gmail.com>
Date: Sat, 9 Oct 2021 20:19:14 +0000 (+0200)
Subject: Document threading support a bit more
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=0309de73dca88009d67993d0f59f9c5c958ae823;p=rust.git

Document threading support a bit more

This adds a few known limitations around threading to the README and suggests the users to look into GitHub issues to learn more.
---

diff --git a/README.md b/README.md
index 7cd802762bf..49a0c3c1f50 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,11 @@ in your program, and cannot run all programs:
   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 SIMD or networking.
+* Threading support is not finished yet. E.g. weak memory effects are not
+  emulated and spin loops (without syscalls) just loop forever. There's no
+  threading support on Windows.
+
+Consider looking into GitHub isues for more information about the limitations.
 
 [rust]: https://www.rust-lang.org/
 [mir]: https://github.com/rust-lang/rfcs/blob/master/text/1211-mir.md