about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2024-05-04 11:49:24 +0200
committerRalf Jung <post@ralfj.de>2024-05-04 14:07:17 +0200
commit38598e68c5d6c204d392af8b17ae4fc64ba6eccf (patch)
tree2328570af874aab2c3bd3ddab5cdfebdb45cfd35
parent6df585ade577933bdd89c376f4edc0b01b8d37e6 (diff)
document unofficially supported OSes
-rw-r--r--src/tools/miri/README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/tools/miri/README.md b/src/tools/miri/README.md
index ef01ca25fb0..616426bd838 100644
--- a/src/tools/miri/README.md
+++ b/src/tools/miri/README.md
@@ -224,8 +224,11 @@ degree documented below):
 - `s390x-unknown-linux-gnu` is supported as our "big-endian target of choice".
 - For every other target with OS `linux`, `macos`, or `windows`, Miri should generally work, but we
   make no promises and we don't run tests for such targets.
-- For targets on other operating systems, even basic operations such as printing to the standard
-  output might not work, and Miri might fail before even reaching the `main` function.
+- We have unofficial support (not maintained by the Miri team itself) for some further operating systems.
+  - `freebsd`: **maintainer wanted**. Supports `std::env` and parts of `std::{thread, fs}`, but not `std::sync`.
+  - `android`: **maintainer wanted**. Support very incomplete, but a basic "hello world" works.
+  - `wasm`: **maintainer wanted**. Support very incomplete, not even standard output works, but an empty `main` function works.
+- For targets on other operating systems, Miri might fail before even reaching the `main` function.
 
 However, even for targets that we do support, the degree of support for accessing platform APIs
 (such as the file system) differs between targets: generally, Linux targets have the best support,