Skip to content

Commit 1581d08

Browse files
committed
adjust wording and fix typos in target documentation
1 parent 77e03a9 commit 1581d08

File tree

4 files changed

+22
-6
lines changed

4 files changed

+22
-6
lines changed

library/Cargo.lock

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,7 @@ dependencies = [
333333
"rustc-demangle",
334334
"std_detect",
335335
"unwind",
336+
"vex-sdk",
336337
"wasi",
337338
"windows-targets 0.0.0",
338339
]
@@ -401,6 +402,16 @@ dependencies = [
401402
"rustc-std-workspace-core",
402403
]
403404

405+
[[package]]
406+
name = "vex-sdk"
407+
version = "0.17.0"
408+
source = "registry+https://github.com/rust-lang/crates.io-index"
409+
checksum = "f285bbc2b96fc4c7fae42ebe365dd2e9121e7002a58b1a9e0e4b1d14dba4d6d0"
410+
dependencies = [
411+
"compiler_builtins",
412+
"rustc-std-workspace-core",
413+
]
414+
404415
[[package]]
405416
name = "wasi"
406417
version = "0.11.0+wasi-snapshot-preview1"

library/panic_abort/Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,7 @@ compiler_builtins = "0.1.0"
1919

2020
[target.'cfg(not(all(windows, target_env = "msvc")))'.dependencies]
2121
libc = { version = "0.2", default-features = false }
22+
23+
[lints.rust.unexpected_cfgs]
24+
level = "warn"
25+
check-cfg = ['cfg(target_os, values("vexos"))']

library/std/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ level = "warn"
143143
check-cfg = [
144144
'cfg(bootstrap)',
145145
'cfg(target_arch, values("xtensa"))',
146+
'cfg(target_os, values("vexos"))',
146147
# std use #[path] imports to portable-simd `std_float` crate
147148
# and to the `backtrace` crate which messes-up with Cargo list
148149
# of declared features, we therefor expect any feature cfg

src/doc/rustc/src/platform-support/armv7a-vex-v5.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Allows compiling user programs for the [VEX V5 Brain](https://www.vexrobotics.com/276-4810.html), a microcontroller for educational and competitive robotics.
77

8-
Rust support for this target is not affiliated with VEX Robotics or IFI, and is not derived from nor used with any official VEX SDK.
8+
Rust support for this target is not affiliated with VEX Robotics or IFI.
99

1010
## Target maintainers
1111

@@ -29,7 +29,7 @@ This target generates binaries in the ELF format that may uploaded to the brain
2929

3030
## Building the target
3131

32-
Rust does not ship pre-compiled artifacts for this target. You can use `build-std` feature to build ELF binaries with `std` support.
32+
Rust does not ship pre-compiled artifacts for this target. You can use the `build-std` feature to build ELF binaries with `std` support.
3333

3434
`.cargo/config.toml`:
3535

@@ -44,9 +44,9 @@ build-std-features = ["compiler-builtins-mem"]
4444

4545
## Building Rust programs
4646

47-
The recommended way to build artifacts that can be installed and run on V5 Brain is by using the [cargo-v5](https://github.com/vexide/cargo-v5) tool. This tool wraps the `cargo build` command by supplying arguments necessary to build the target, while also providing uploading functionality.
47+
The recommended way to build artifacts that run on V5 Brain is by using the [cargo-v5](https://github.com/vexide/cargo-v5) tool. This tool wraps the `cargo build` command by supplying arguments necessary to build the target, while also providing functionality for uploading over USB to a V5 Controller or Brain.
4848

49-
To install the tool run:
49+
To install the tool, run:
5050

5151
```sh
5252
cargo install cargo-v5
@@ -70,15 +70,15 @@ To build an uploadable BIN file using the release profile, run:
7070
cargo v5 build --release
7171
```
7272

73-
Programs can also be directly uploaded to the brain over a USB connection after building:
73+
Programs can also be directly uploaded to the brain over a USB connection immediately after building:
7474

7575
```sh
7676
cargo v5 upload --release
7777
```
7878

7979
## Testing
8080

81-
Binaries built for this target can be run in an emulator (such as [vex-v5-qemu](https://github.com/vexide/vex-v5-qemu)), or uploaded to a device over a USB or bluetooth connection.
81+
Binaries built for this target can be run in an emulator (such as [vex-v5-qemu](https://github.com/vexide/vex-v5-qemu)), or uploaded to a physical device over a serial (USB) connection.
8282

8383
The default Rust test runner is not supported.
8484

0 commit comments

Comments
 (0)