Skip to content

Commit d2253be

Browse files
authored
Document supported platforms (#1431)
We add a section in README.md and mention the level of support we provide for each platform (target triple) in a similar way the Rust project defines "tiers". Closes: #1430
1 parent 4ef713e commit d2253be

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,34 @@ latest Rust toolchain rather than relying on an outdated version of Rust.
134134
Note, however, that we may switch to a more conservative MSRV policy in the future when MMTk reaches
135135
a stable state.
136136

137+
## Supported platforms
138+
139+
Like [Rust platform support tiers][rustps], supports for MMTk core on different platforms (targets) are organized into three tiers.
140+
141+
- Tier 1 platforms are guaranteed to work.
142+
- Tier 2 platforms are guaranteed to build.
143+
- Tier 3 platforms have support in the mmtk-core code base, but we make no guarantee whether they will build or work.
144+
145+
Here is a list of supported platforms.
146+
147+
| Platform | Rust tier | MMTk tier | Notes |
148+
|-----------------------------|-----------|-----------|-------|
149+
| x86_64-unknown-linux-gnu | 1 | 1 | |
150+
| i686-unknown-linux-gnu | 1 | 1 | |
151+
| x86_64-apple-darwin | 2 | 2 | (1) |
152+
| aarch64-unknown-linux-gnu | 1 | 3 | |
153+
| riscv64gc-unknown-linux-gnu | 2 | 3 | |
154+
| aarch64-linux-android | 2 | 3 | |
155+
| x86_64-linux-android | 2 | 3 | |
156+
157+
Notes:
158+
159+
1. Rust recently [demoted][x86appledem] x86_64-apple-darwin to Tier 2. We will replace it with aarch64-apple-darwin in the future.
160+
161+
[rustps]: https://doc.rust-lang.org/nightly/rustc/platform-support.html
162+
[x86appledem]: https://github.com/mmtk/mmtk-core/issues/1365
163+
[mmtk-art]: https://github.com/k-sareen/mmtk-art
164+
137165
## Contributing to MMTk
138166

139167
Thank you for your interest in contributing to MMTk. We appreciate all the contributors. Generally you can contribute to MMTk by either

0 commit comments

Comments
 (0)