DOCS(building): clarify Windows build & pre-built environments#7145
DOCS(building): clarify Windows build & pre-built environments#7145citelao wants to merge 5 commits intomumble-voip:masterfrom
Conversation
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.
WalkthroughThe PR updates the build documentation across multiple files. Possibly related PRs
🚥 Pre-merge checks | ✅ 1 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (5)
docs/dev/build-instructions/build_static.mddocs/dev/build-instructions/build_windows.mddocs/dev/build-instructions/common_build_errors.mddocs/dev/build-instructions/faq.mddocs/dev/build-instructions/setup_visual_studio.md
maxer137
left a comment
There was a problem hiding this comment.
Looks good to me! 👍
It might be nice to have someone else test the steps and see if they could follow them.
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.
|
@Krzmbrzl, I should have addressed your feedback! Sorry for the delay. |
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.