Skip to content

Commit fd81b99

Browse files
committed
Add docs for Switch target
1 parent c690db4 commit fd81b99

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

src/doc/rustc/src/platform-support.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ target | std | host | notes
209209
`aarch64-apple-tvos` | * | | ARM64 tvOS
210210
[`aarch64-apple-watchos-sim`](platform-support/apple-watchos.md) | ✓ | | ARM64 Apple WatchOS Simulator
211211
[`aarch64-kmc-solid_asp3`](platform-support/kmc-solid.md) | ✓ | | ARM64 SOLID with TOPPERS/ASP3
212-
`aarch64-nintendo-switch` | * | | ARM64 Nintendo Switch, Horizon
212+
[`aarch64-nintendo-switch`](platform-support/aarch64-nintendo-switch.md) | * | | ARM64 Nintendo Switch, Horizon
213213
[`aarch64-pc-windows-gnullvm`](platform-support/pc-windows-gnullvm.md) | ✓ | ✓ |
214214
`aarch64-unknown-freebsd` | ✓ | ✓ | ARM64 FreeBSD
215215
`aarch64-unknown-hermit` | ✓ | | ARM64 HermitCore
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# aarch64-nintendo-switch
2+
3+
**Tier: 3**
4+
5+
Nintendo Switch with pure-Rust toolchain.
6+
7+
## Designated Developers
8+
9+
* [@leo60228](https://github.com/leo60228)
10+
* [@jam1garner](https://github.com/jam1garner)
11+
12+
## Requirements
13+
14+
This target is cross-compiled.
15+
It has no special requirements for the host.
16+
17+
## Building
18+
19+
The target can be built by enabling it for a `rustc` build:
20+
21+
```toml
22+
[build]
23+
build-stage = 1
24+
target = ["aarch64-nintendo-switch"]
25+
```
26+
27+
## Cross-compilation
28+
29+
This target can be cross-compiled from any host.
30+
31+
## Testing
32+
33+
Currently there is no support to run the rustc test suite for this target.
34+
35+
## Building Rust programs
36+
37+
If `rustc` has support for that target and the library artifacts are available,
38+
then Rust programs can be built for that target:
39+
40+
```text
41+
rustc --target aarch64-nintendo-switch your-code.rs
42+
```
43+
44+
To generate binaries in the NRO format that can be easily run on-device, you
45+
can use [cargo-nx](https://github.com/aarch64-switch-rs/cargo-nx):
46+
47+
```text
48+
cargo nx --triple=aarch64-nintendo-switch
49+
```

0 commit comments

Comments
 (0)