Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit aadbe8f

Browse files
committed
explain which targets we support to what extent
1 parent 58fdd55 commit aadbe8f

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,28 @@ for seed in $({ echo obase=16; seq 255; } | bc); do
194194
done
195195
```
196196

197+
### Supported targets
198+
199+
Miri does not support all targets supported by Rust. The good news, however, is
200+
that no matter your host OS/platform, it is easy to run code for *any* target
201+
using `--target`!
202+
203+
The following targets are tested on CI and thus should always work (to the
204+
degree documented below):
205+
206+
- The best-supported target is `x86_64-unknown-linux-gnu`. Miri releases are
207+
blocked on things working with this target. Most other Linux targets should
208+
also work well; we do run the test suite on `i686-unknown-linux-gnu` as a
209+
32bit target and `mips64-unknown-linux-gnuabi64` as a big-endian target.
210+
- `x86_64-apple-darwin` should work basically as well as Linux. We also test
211+
`aarch64-apple-darwin`. However, we might ship Miri with a nightly even when
212+
some features on these targets regress.
213+
- `x86_64-pc-windows-msvc` works, but supports fewer features than the Linux and
214+
Apple targets. For example, file system access and concurrency are not
215+
supported on Windows. We also test `i686-pc-windows-msvc`, with the same
216+
reduced feature set. We might ship Miri with a nightly even when some features
217+
on these targets regress.
218+
197219
### Common Problems
198220

199221
When using the above instructions, you may encounter a number of confusing compiler

0 commit comments

Comments
 (0)