Skip to content

Commit 5239a2a

Browse files
committed
Add illumos target documentation
1 parent 32c8a9f commit 5239a2a

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# `aarch64-unknown-illumos` and `x86_64-unknown-illumos`
2+
3+
**Tier: 2/3**
4+
5+
[illumos](https://www.illumos.org/), is a Unix operating system which provides next-generation features for downstream distributions,
6+
including advanced system debugging, next generation filesystem, networking, and virtualization options.
7+
8+
## Target maintainers
9+
10+
- Joshua M. Clulow ([@jclulow](https://github.com/jclulow))
11+
- Patrick Mooney ([@pfmooney](https://github.com/pfmooney))
12+
13+
## Requirements
14+
15+
The target supports host tools.
16+
17+
The illumos target supports `std` and uses the standard ELF file format.
18+
19+
`x86_64-unknown-illumos` is a tier 2 target with host tools.
20+
`aarch64-unknown-illumos` is a tier 3 target.
21+
22+
## Building the target
23+
24+
These targets can be built by adding `aarch64-unknown-illumos` and
25+
`x86_64-unknown-illumos` as targets in the rustc list.
26+
27+
## Building Rust programs
28+
29+
Rust ships pre-compiled artifacts for the `x86_64-unknown-illumos` target.
30+
Rust does not ship pre-compiled artifacts for `aarch64-unknown-illumos`,
31+
it requires building the target either as shown above or using `-Zbuild-std`.
32+
33+
## Testing
34+
35+
Tests can be run in the same way as a regular binary.
36+
37+
## Cross-compilation toolchains and C code
38+
39+
The target supports C code.
40+
41+
The illumos project makes available [prebuilt sysroot artefacts](https://github.com/illumos/sysroot) which can be used for cross compilation.
42+
The official Rust binaries are cross-compiled using these artefacts.

0 commit comments

Comments
 (0)