Fix footgun for Windows users in fast_config.toml
#14103
Merged
Conversation
This file contains 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
janhohenheim
added
C-Bug
BD103
approved these changes
Jul 2, 2024
BD103
added
the
S-Needs-Review
alice-i-cecile
approved these changes
Jul 2, 2024
alice-i-cecile
added
S-Ready-For-Final-Review
zmbush
pushed a commit
to zmbush/bevy
that referenced
this pull request
Jul 3, 2024
# Objective - bevyengine#13136 changed the default value of `-Zshare-generics=n` to `-Zshare-generics=y` on Windows - New users are encouraged to use dynamic builds and LLD when setting up Bevy - New users are also encouraged to check out `fast_config.toml` - bevyengine#1126 means that running dynamic builds, using LLD and sharing generics on Windows results in a cryptic error message As a result, a new Windows user following all recommendations for better compiles is actually not able to compile Bevy at all. ## Solution - Set `-Zshare-generics=n` on Windows with a comment saying this is for dynamic linking ## Testing I verified that bevyengine#1126 is still in place on the current nightly (1.80) ## Additional Info Maybe the website should mention this as well? The relevant snippet there looks like this: ```toml # /path/to/project/.cargo/config.toml [target.x86_64-unknown-linux-gnu] rustflags = [ # (Nightly) Make the current crate share its generic instantiations "-Zshare-generics=y", ] ``` so it kinda implies it's only for Linux? Which is not quite true, this setting works on macOS as well AFAIK
MrGVSV
pushed a commit
to MrGVSV/bevy
that referenced
this pull request
Jul 5, 2024
# Objective - bevyengine#13136 changed the default value of `-Zshare-generics=n` to `-Zshare-generics=y` on Windows - New users are encouraged to use dynamic builds and LLD when setting up Bevy - New users are also encouraged to check out `fast_config.toml` - bevyengine#1126 means that running dynamic builds, using LLD and sharing generics on Windows results in a cryptic error message As a result, a new Windows user following all recommendations for better compiles is actually not able to compile Bevy at all. ## Solution - Set `-Zshare-generics=n` on Windows with a comment saying this is for dynamic linking ## Testing I verified that bevyengine#1126 is still in place on the current nightly (1.80) ## Additional Info Maybe the website should mention this as well? The relevant snippet there looks like this: ```toml # /path/to/project/.cargo/config.toml [target.x86_64-unknown-linux-gnu] rustflags = [ # (Nightly) Make the current crate share its generic instantiations "-Zshare-generics=y", ] ``` so it kinda implies it's only for Linux? Which is not quite true, this setting works on macOS as well AFAIK
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Objective
config_fast_builds.toml#13136 changed the default value of-Zshare-generics=nto-Zshare-generics=yon Windowsfast_config.tomlSTATUS_ENTRYPOINT_NOT_FOUND#1126 means that running dynamic builds, using LLD and sharing generics on Windows results in a cryptic error messageAs a result, a new Windows user following all recommendations for better compilation times is actually not able to compile Bevy at all.
Solution
-Zshare-generics=non Windows with a comment saying this is for dynamic linkingTesting
I verified that #1126 is still happening on the current nightly (1.80)
Additional Info
Maybe the website should mention this as well? The relevant snippet there looks like this:
so it kinda implies it's only for Linux? Which is not quite true, this setting works on macOS as well AFAIK