-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[READY FOR REVIEW][DNM] Refresh WindowsBuild.md
#41560
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.
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
base: main
Are you sure you want to change the base?
Conversation
2be0ddf
to
7e58d8f
Compare
Something to check with @compnerd |
de227ab
to
f48eefe
Compare
WindowsBuild.md
I believe this guide is ready for review, but here are still some related PRs that had better go first.
|
96ba4bb
to
d8b6901
Compare
6e23a0a
to
0aad7cd
Compare
7ad643d
to
aab1aa6
Compare
For anyone who may be concerned: This PR is fully ready for review now. I have validated all the build steps with a fresh build locally, including the functionality of built toolchain. Before it can get merged, we’d better address the issues listed in #41560 (comment). However, the guide itself should be complete and qualified. |
WindowsBuild.md
WindowsBuild.md
0dd5a2e
to
69586da
Compare
69586da
to
3003b08
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've not gone through everything, but please change the existing things, I'll look through the rest after those changes are made.
5. Click *Install* | ||
|
||
## Enable Developer Mode | ||
### Set up `vcpkg` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add instructions for building from source rather than vcpkg. I do not wish to have this be the recommended path. Having vcpkg as an option in an appendix is okay though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vcpkg
doesn’t have prebuilt binaries. It will build everything from source.
|
||
The instructions assume that the dependencies are in `S:/Library`. The directory | ||
structure should resemble: | ||
You'll be able to clone and check out the rest of Swift source repositories with `update-checkout` tool: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add the commands for cloning the sources for dependencies please.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer vcpkg
over custom builds. We’re not telling a story of how to build a standard toolchain. This one is just for debugging (as is mentioned in the note), so the easiest & most efficient way should be recommended.
path S:\b\3\bin;%PATH% | ||
cmake -B S:\b\5 ^ | ||
-D CMAKE_BUILD_TYPE=RelWithDebInfo ^ | ||
-D CMAKE_INSTALL_PREFIX=S:\b\sdk\usr ^ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please fix the path.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don’t think we need the path. Why? For TestFoundation
support, see swiftlang/swift-corelibs-foundation#3146
|
||
```cmd | ||
cmake -B S:\b\4 ^ | ||
-D CMAKE_BUILD_TYPE=RelWithDebInfo ^ | ||
-D CMAKE_INSTALL_PREFIX=C:\Library\Developer\Toolchains\unknown-Asserts-development.xctoolchain\usr ^ | ||
-D CMAKE_INSTALL_PREFIX=S:\b\sdk\usr ^ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please restore the original path.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Again — this guide is for debugging purpose, fixing to standard path is unnecessary, and will conflict with pre-installed Swift toolchains. Having it installed next to the source will empower us to test the toolchain standalone.
-D LIT_COMMAND=S:\llvm-project\llvm\utils\lit\lit.py ^ | ||
-D dispatch_DIR=S:\b\3\cmake\modules ^ | ||
|
||
-D CMAKE_TOOLCHAIN_FILE=S:\vcpkg\scripts\buildsystems\vcpkg.cmake ^ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please drop this and the same througout.
Addressed some of the feedbacks reasonable from my side. |
Polish Windows build guide from head to tail:
update-checkout
instead of manual checkout;-DLLVM_ENABLE_PDB=YES
with Swift compiler;vcpkg
to pull in dependencies;Future direction will be adding not-yet-supported build steps for anyone who would like to fix.
Resolves SR-NNNN.