Skip to content

DOCS(building): clarify Windows build & pre-built environments#7145

Open
citelao wants to merge 5 commits intomumble-voip:masterfrom
citelao:user/citelao/clearer_windows_build_instructions
Open

DOCS(building): clarify Windows build & pre-built environments#7145
citelao wants to merge 5 commits intomumble-voip:masterfrom
citelao:user/citelao/clearer_windows_build_instructions

Conversation

@citelao
Copy link
Copy Markdown

@citelao citelao commented Apr 1, 2026

This change updates our build documentation to provide clearer instructions for buillding on Windows, setting up Visual Studio, and using pre-built environments.

It also documents some more build errors.

Ben Stolovitz added 3 commits March 31, 2026 20:40
This change adds more context to building on Windows, documents how to
use pre-built environments, and adds some common build errors.
This change simplifies our pre-built env instructions to avoid redundant
examples.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 1, 2026

Walkthrough

The PR updates the build documentation across multiple files. build_static.md is significantly expanded to include a typical build flow overview, detailed dependency setup using pre-built vcpkg environments, and updated CMake configuration examples with multi-line syntax. build_windows.md is slightly simplified with consolidated wording. common_build_errors.md adds new entries for missing CompilerFlags and Windows linker errors related to pre-built vcpkg environments. setup_visual_studio.md is extensively expanded with step-by-step Visual Studio component installation instructions and detailed MSVC environment setup via vcvars64.bat. faq.md adds a reference to the common build errors documentation.

Possibly related PRs

🚥 Pre-merge checks | ✅ 1 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the main scope (Windows build clarity, Visual Studio setup, pre-built environments, build errors) but lacks required checkbox completion and is relatively brief. Complete the commit guidelines checkbox and expand description with more specific details about what was changed and why.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and specifically relates to the main changes—clarifying Windows build instructions and documenting pre-built environments.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@citelao
Copy link
Copy Markdown
Author

citelao commented Apr 1, 2026

@maxer137 this is docs change extracted from #7136. I tried to address most of the feedback.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/dev/build-instructions/setup_visual_studio.md (1)

47-47: Consider using "64-bit" for consistency.

The hyphenated form "64-bit" is more standard in technical documentation when used as an adjective.

📝 Proposed fix
-These have some caveats that recommend using the `vcvars64.bat` or `vcvarsall.bat` technique instead: only **x64 Native Tools Command Prompt** supports building in 64-bit, but it is CMD, not PowerShell. The **Developer Powershell** shortcut is 32-bit only. If you are on a 64bit system, then you'll know that you have opened the correct prompt, if it prints `Environment initialized for: 'x64'`.
+These have some caveats that recommend using the `vcvars64.bat` or `vcvarsall.bat` technique instead: only **x64 Native Tools Command Prompt** supports building in 64-bit, but it is CMD, not PowerShell. The **Developer Powershell** shortcut is 32-bit only. If you are on a 64-bit system, then you'll know that you have opened the correct prompt, if it prints `Environment initialized for: 'x64'`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/dev/build-instructions/setup_visual_studio.md` at line 47, Replace
inconsistent "64bit" usages with the hyphenated adjective form "64-bit" for
consistency: change "64bit system" to "64-bit system" and any other occurrences
in the same sentence such as making sure "x64 Native Tools Command Prompt
supports building in 64-bit" retains "64-bit"; also correct "Developer
Powershell" capitalization to "Developer PowerShell" if needed. Update the
sentence containing "x64 Native Tools Command Prompt", "Developer Powershell",
and "64bit system" so all instances use "64-bit" when used as an adjective and
"PowerShell" for the shell name.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/dev/build-instructions/common_build_errors.md`:
- Line 9: The error message points to the wrong include location: the
include(CompilerFlags) invocation actually comes from the compiler include (via
include(compiler)), not from qt-utils; update the code that constructs the CMake
include error message so it references the correct include/source (the one that
defines include(CompilerFlags)) and ensure the include names in the message
match the actual include call strings 'CompilerFlags' and 'compiler' so the
reported origin matches the real source.

---

Nitpick comments:
In `@docs/dev/build-instructions/setup_visual_studio.md`:
- Line 47: Replace inconsistent "64bit" usages with the hyphenated adjective
form "64-bit" for consistency: change "64bit system" to "64-bit system" and any
other occurrences in the same sentence such as making sure "x64 Native Tools
Command Prompt supports building in 64-bit" retains "64-bit"; also correct
"Developer Powershell" capitalization to "Developer PowerShell" if needed.
Update the sentence containing "x64 Native Tools Command Prompt", "Developer
Powershell", and "64bit system" so all instances use "64-bit" when used as an
adjective and "PowerShell" for the shell name.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6c3085b7-d349-452f-a74e-0655b47f7de5

📥 Commits

Reviewing files that changed from the base of the PR and between f2a0d8e and 7d09173.

📒 Files selected for processing (5)
  • docs/dev/build-instructions/build_static.md
  • docs/dev/build-instructions/build_windows.md
  • docs/dev/build-instructions/common_build_errors.md
  • docs/dev/build-instructions/faq.md
  • docs/dev/build-instructions/setup_visual_studio.md

Comment thread docs/dev/build-instructions/common_build_errors.md
Copy link
Copy Markdown
Contributor

@maxer137 maxer137 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! 👍

It might be nice to have someone else test the steps and see if they could follow them.

Comment thread docs/dev/build-instructions/build_static.md Outdated
Comment thread docs/dev/build-instructions/build_static.md
Comment thread docs/dev/build-instructions/build_static.md Outdated
Comment thread docs/dev/build-instructions/build_static.md
citelao added 2 commits April 21, 2026 03:19
This documents the python requirement in the main contribution README.
This change removes some filler words and adds
some now-required flags to all examples.
@citelao
Copy link
Copy Markdown
Author

citelao commented Apr 21, 2026

@Krzmbrzl, I should have addressed your feedback! Sorry for the delay.

@citelao citelao requested a review from Krzmbrzl April 21, 2026 03:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants