Skip to content

docs: document Windows GNU target requirement #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Wenzel merged 2 commits into from
Sep 16, 2026
+25 −0
Merged

docs: document Windows GNU target requirement #388

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ab6e85
docs: document Windows GNU target requirement
Wenzel Sep 14, 2026
71ec39c
docs: move Windows GNU-target note from README to setup guide
Wenzel Sep 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/src/setup/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ should be run in PowerShell (the default shell on recent Windows versions).
- [Set Up For Local Development](#set-up-for-local-development)
- [Troubleshooting](#troubleshooting)
- [I Already Have A MinGW Installation](#i-already-have-a-mingw-installation)
- [I Already Have A Rust Installation](#i-already-have-a-rust-installation)
- [Command is Unrecognized](#command-is-unrecognized)

## Install System Dependencies
Expand Down Expand Up @@ -322,6 +323,30 @@ it to `C:\MinGW`, edit `compiler.mk` and point `CC=` and `CXX=` at your MinGW `g
and `g++.exe` binaries, respectively, or change the location passed with the
`--mingw-dir` option in [the build step](#build-tsffs).

### I Already Have A Rust Installation

`rustup`'s default host on Windows is the `x86_64-pc-windows-msvc` toolchain, not the
`x86_64-pc-windows-gnu` one this guide installs. If you already had Rust installed before
following this guide, your default host is likely still MSVC. Building/testing TSFFS
with the MSVC host fails at the link step (`LNK1107: invalid or corrupt file`) because
MSVC's `link.exe` can't consume the raw Windows link directives TSFFS's SIMICS build
dependencies emit -- only `x86_64-pc-windows-gnu`'s linker can. `cargo check`/`cargo
clippy` will still succeed either way (they don't link), which can hide the problem until
a real `cargo build`/`cargo test`.

Check your default host with `rustup show`. If it says `x86_64-pc-windows-msvc`, either
install the `x86_64-pc-windows-gnu` toolchain and set a repo-local override:

```powershell
rustup toolchain install stable-x86_64-pc-windows-gnu
rustup override set stable-x86_64-pc-windows-gnu
```

or pass `--target x86_64-pc-windows-gnu` explicitly on each `cargo`/`cargo simics-build`
invocation. See the `build_windows` job in
[`ci.yml`](https://github.com/intel/tsffs/blob/main/.github/workflows/ci.yml) for the
exact setup CI uses.

### Command is Unrecognized

If PowerShell complains that any command above is not recognized, take the following
Expand Down
Loading