Skip to main content

Module doctor

Module doctor 

Source
Expand description

doctor: checks the toolchain a game on the engine builds with: Rust and Cargo, rustup’s targets, MSYS2’s linker and objcopy on the Windows GNU toolchain (AGENTS.md), on Linux the C linker, pkg-config and the system libraries the backend links and opens, and the web target. Each check says what it found and, if it failed, how to fix it (its help): on Linux, the install command for the distribution’s package manager (/etc/os-release), and scripts/setup-linux.sh, which installs the same list. It passes when every check does; when one fails, it answers codes::TOOLCHAIN and exits 3.

What it runs and looks at goes through a Probe, so its tests can give it any machine.

Structs§

Check
One check.
DoctorInput
What doctor checks: everything (nothing to choose yet).
DoctorOutput
What doctor found.
ThisMachine
The machine doctor runs on.

Constants§

MSYS2_GCC
Where MSYS2 puts the mingw-w64 GCC that links on the Windows GNU toolchain (the engine’s .cargo/config.toml names it as the linker).
WASM_TARGET
The web build’s target.

Traits§

Probe
How doctor looks at the machine.

Functions§

checks
doctor’s checks of the machine probe looks at.
doctor
doctor on the machine probe looks at.
text
What doctor found, for people.