document platform support in readme

This commit is contained in:
gnzlbg 2018-10-24 11:01:42 +02:00 committed by gnzlbg
parent 641d054ce0
commit 50b7fcca46
1 changed files with 36 additions and 0 deletions

View File

@ -27,6 +27,42 @@ static ALLOC: jemallocator::Jemalloc = jemallocator::Jemalloc;
And that's it! Once you've defined this `static` then jemalloc will be used for
all allocations requested by Rust code in the same program.
# Platform support
The following table describes the supported platforms:
* `build`: does the library compile for the target?
* `run`: do the tests pass on the target?
Tier 1 targets are tested on all Rust channels (stable, beta, and nightly). All
other targets are only tested on Rust nightly.
| Linux targets: | build | run |
|-------------------------------------|-----------|---------|
| `aarch64-unknown-linux-gnu` | ✓ | ✓ |
| `arm-unknown-linux-gnueabi` | ✓ | ✓ |
| `armv7-unknown-linux-gnueabi` | ✓ | ✓ |
| `i586-unknown-linux-gnu` | ✓ | ✓ |
| `i686-unknown-linux-gnu` (tier 1) | ✓ | ✓ |
| `mips-unknown-linux-gnu` | ✓ | ✓ |
| `mipsel-unknown-linux-musl` | ✓ | ✓ |
| `mips64-unknown-linux-gnuabi64` | ✓ | ✓ |
| `mips64el-unknown-linux-gnuabi64` | ✓ | ✓ |
| `powerpc-unknown-linux-gnu` | ✓ | ✓ |
| `powerpc64-unknown-linux-gnu` | ✓ | ✓ |
| `powerpc64le-unknown-linux-gnu` | ✓ | ✓ |
| `x86_64-unknown-linux-gnu` (tier 1) | ✓ | ✓ |
| **MacOSX targets:** | **build** | **run** |
| `x86_64-apple-darwin` (tier 1) | ✓ | ✓ |
| `i686-apple-darwin` (tier 1) | ✓ | ✓ |
| **Windows targets:** | **build** | **run** |
| `x86_64-pc-windows-msvc` (tier 1) | ✗ | ✗ |
| `i686-pc-windows-msvc` (tier 1) | ✗ | ✗ |
| `x86_64-pc-windows-gnu` (tier 1) | ✓ | ✓ |
| `i686-pc-windows-gnu` (tier 1) | ✓ | ✓ |
| **Android targets:** | **build** | **run** |
| `aarch64-linux-android` | ✓ | ✓ |
| `x86_64-linux-android` | ✓ | ✓ |
# Features