From 0309de73dca88009d67993d0f59f9c5c958ae823 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Habov=C5=A1tiak?= Date: Sat, 9 Oct 2021 22:19:14 +0200 Subject: [PATCH 1/3] 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. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7cd802762b..49a0c3c1f5 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 From 31ed3a7120d3d64389d9e0835ca25d6e1076db43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Habov=C5=A1tiak?= Date: Tue, 12 Oct 2021 11:09:43 +0200 Subject: [PATCH 2/3] Typo fixes Co-authored-by: Ralf Jung --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 49a0c3c1f5..aa016fc079 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,8 @@ 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 is not finished yet. E.g., weak memory effects are not + emulated and spin loops (without syscalls) just loop forever. There is no threading support on Windows. Consider looking into GitHub isues for more information about the limitations. From 782085adcd9d3434db20e59585ee20d86e703211 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Habov=C5=A1tiak?= Date: Tue, 12 Oct 2021 18:46:23 +0200 Subject: [PATCH 3/3] Remove vague statement from README Addresses https://github.com/rust-lang/miri/pull/1898#discussion_r727274293 --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index aa016fc079..0c5b591e72 100644 --- a/README.md +++ b/README.md @@ -63,8 +63,6 @@ in your program, and cannot run all programs: emulated and spin loops (without syscalls) just loop forever. There is 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 [`unreachable_unchecked`]: https://doc.rust-lang.org/stable/std/hint/fn.unreachable_unchecked.html