docs: document Windows GNU target requirement - #388
Merged
Merged
Conversation
Building/testing this crate on Windows requires the x86_64-pc-windows-gnu Rust target, not the MSVC host rustup defaults to. MSVC's link.exe can't consume the raw Windows link directives this crate's SIMICS build dependencies emit, so a default cargo build/test silently targets MSVC and fails to link (or, with cargo check/clippy, appears to work without proving a real build would). This was previously only discoverable via a comment in .github/workflows/ci.yml's build_windows job; add a compact note to README.md so it's obvious up front. Keep this out of CONTRIBUTING.md -- it's a build requirement, not a contribution-process note. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Wenzel
force-pushed
the
docs/windows-gnu-build-target
branch
from
September 14, 2026 11:16
2a4cc6a to
8ab6e85
Compare
The README note was too specific for a project overview -- move the detail into docs/src/setup/windows.md's Troubleshooting section, next to the existing MinGW troubleshooting entry, since that's where anyone actually working through Windows setup will look. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Building/testing this crate on Windows requires the x86_64-pc-windows-gnu Rust target, not the MSVC host rustup defaults to. MSVC's link.exe can't consume the Windows link directives this crate's SIMICS build dependencies emit, so a default cargo build/test silently targets MSVC and fails to link (or, with cargo check/clippy, appears to work without proving a real build would). This was previously only discoverable via a comment in .github/workflows/ci.yml's build_windows job; add a short pointer to README.md and a brief setup section to CONTRIBUTING.md so it's obvious up front.