Skip to content

Commit b9d1624

Browse files
authored
Add a note that no_std builds panic on contention (bytecodealliance#10155)
While it's predicted that `no_std` builds won't be using threading that's not necessarily a given. Add a note to the documentation to call out that `no_std` builds panic on contention with a request for filing an issue if that's not suitable.
1 parent febd080 commit b9d1624

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/stability-tiers.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,10 @@ that will require building from source.
144144

145145
[^5]: Rust targets that are `#![no_std]` don't support the entire feature set of
146146
Wasmtime. For example the `threads` Cargo feature requires the standard library.
147-
For more information see the [`no_std` documentation][nostd].
147+
For more information see the [`no_std` documentation][nostd]. Additionally these
148+
targets are sound in the presence of multiple threads but will panic on
149+
contention of data structures. If you're doing multithreaded things in `no_std`
150+
please file an issue so we can help solve your use case.
148151

149152
[nostd]: ./stability-platform-support.md
150153

0 commit comments

Comments
 (0)