Clarify that build needs to run from VS Developer shell for Windows builds#1056
Clarify that build needs to run from VS Developer shell for Windows builds#1056
Conversation
I suspect that many people will only encounter aws-lc-rs as a dependency of a dependency of a dependency, say, they just wanted to use reqwest, and now their build fails. They will hopefully find this guide and install requirements, but their build will still fail since normally cargo can build from a regular shell. I've added a note to the Troubleshooting section, but maybe this needs to be displayed more prominently.
|
Thanks for the PR!
I think we should address this build failure directly, as few consumers will bother to look for our documentation. In my experience, I've been able to get the build to succeed from a regular shell on Windows. I'm wondering if you can tell me more about what happens when it fails like this? What did the build error messaging indicate as the problem? |
|
Yes, fixing it in the build would be best! I did not find the build output very helpful, so I've attached most if it as a file. I've noticed that it misses a bunch of probably useful environment variables, but I may be completely misguided, so please take a look yourself. In case it helps, here's the list of variables I see in the regular Windows PowerShell shell of Terminal:
And for comparison, here's the list of variables I see in Developer PowerShell for VS 18 (note all
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1056 +/- ##
==========================================
- Coverage 95.80% 92.67% -3.13%
==========================================
Files 61 71 +10
Lines 8143 10143 +2000
Branches 0 10143 +10143
==========================================
+ Hits 7801 9400 +1599
- Misses 342 450 +108
- Partials 0 293 +293 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Hello! We just released This PR will now be closed. Feel free to comment here or open an issue if you continue to have problems after upgrading. Thanks for your help with improving our library! 😄 |
3 participants
This is a minor addition to documentation for Windows builds.
I suspect that many people will only encounter aws-lc-rs as a dependency of a dependency of a dependency, say, they just wanted to use reqwest, and now their build fails. They will hopefully find this guide and install requirements, but their build will still fail since normally cargo can build from a regular shell, and this is what they've been doing.
I've added a note to the Troubleshooting section, but maybe this needs to be displayed more prominently.
Issues:
Does not address any open issues.
Description of changes:
No code changes. I hope this will save some time for those who are not direct users of the crate.
Call-outs:
No architecture or design changes.
Testing:
Verified that a build that fails when run from a regular shell is successful when run from VS Developer shell on Windows/aarch64 (the failure is during compilation of aws-lc-sys).
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.