Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 15:14:50 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/.cargo/config_fast_builds.toml

41 lines
2 KiB
TOML
Raw Normal View History

Xtask CI (#1387) This PR is easiest to review commit by commit. Followup on https://github.com/bevyengine/bevy/pull/1309#issuecomment-767310084 - [x] Switch from a bash script to an xtask rust workspace member. - Results in ~30s longer CI due to compilation of the xtask itself - Enables Bevy contributors on any platform to run `cargo ci` to run linting -- if the default available Rust is the same version as on CI, then the command should give an identical result. - [x] Use the xtask from official CI so there's only one place to update. - [x] Bonus: Run clippy on the _entire_ workspace (existing CI setup was missing the `--workspace` flag - [x] Clean up newly-exposed clippy errors ~#1388 builds on this to clean up newly discovered clippy errors -- I thought it might be nicer as a separate PR.~ Nope, merged it into this one so CI would pass. Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2021-02-22 08:42:19 +00:00
# Add the contents of this file to `config.toml` to enable "fast build" configuration. Please read the notes below.
remove specialization. bevy now builds on stable rust!
2020-06-08 06:35:40 +00:00
# NOTE: For maximum performance, build using a nightly compiler
Removed irrelevant note for Mac users (#2017) The removed comment talks about something in the file that no longer exists.
2021-04-27 00:46:41 +00:00
# If you are using rust stable, remove the "-Zshare-generics=y" below.
remove specialization. bevy now builds on stable rust!
2020-06-08 06:35:40 +00:00
Add fast build config example
2020-01-21 11:11:16 +00:00
[target.x86_64-unknown-linux-gnu]
Documentation: simplify NixOS dependencies (#3527) # Objective The description of NixOS dependencies is extremely long and spends entire paragraphs just for simple line changes. With this PR it should be much simpler. ## Solution - Linking Vulkan in `build.rs` is less effective than adding it in LD_LIBRARY_PATH, so I removed the former (related to #1992); - I put a simple comment explaining the line in the list of dependencies, instead of making entire paragraphs; - Clang is not in an absolute path in `.cargo/config_fast_builds` anymore, so that there is no need to specify it in `docs/linux_dependencies.md` (didn't test if this breaks other distros, though I doubt it. Also, maybe it could also be done on Darwin for consistency?); - Also added optional wayland dependencies. A few notes: - The x11 libraries will be linked only during the compilation phase. This means that if you use the `x11` feature without these libraries in the environment (for example because you forget to enter the nix shell before compiling), the program will still compile successfully but won't run. You'll have to `cargo clean` and recompile with the x11 libraries in the environment. I don't know if this is important enough to be added to the documentation, but it's not specified anywhere, though I don't think it's specific to NixOS; - The wayland dependencies need to be put in LD_LIBRARY_PATH only in certain conditions (IIRC, only if using the `dynamic` feature) and the text doesn't specify it. Because putting them there doesn't increase the number of dependencies (they are already in buildInputs) or alter the performance, I doubt anyone will care; - Should I comment out what isn't needed by default? - ~I removed `cargo` from buildInputs. Ignoring the fact that it should be in nativeBuildInputs, having it in `shell.nix` allows to use stable Rust in case it's not in the system environment, but maybe the user wanted to use the version that was already in the system environment and will be caught by surprise. In my opinion, if someone is looking at a Bevy's documentation on NixOS, that user will either have Rust already in the system environment (eg. via rustup) or is capable to add the toolchain they want on shell.nix by themselves. This isn't exactly the place to explain how this works.~ ~EDIT: I replaced `cargo` with Rust from the [Oxalica overlay](https://github.com/oxalica/rust-overlay) in order to have the latest nightly.~ EDIT: Removed `cargo` from dependencies. See comments for details.
2022-01-10 17:05:13 +00:00
linker = "clang"
Improve `config_fast_builds.toml` (#11529) # Objective Theres no explaination for what the compiler flags `config_fast_builds.toml` do ## Solution Explain what the flags in `config_fast_builds.toml` do.
2024-01-25 19:07:51 +00:00
rustflags = [
"-Clink-arg=-fuse-ld=lld", # Use LLD Linker
"-Zshare-generics=y", # (Nightly) Make the current crate share its generic instantiations
Use `-Z threads=0` option in `config_fast_builds.toml` (#11541) # Objective Improve compile times. ## Solution The `-Z threads=0` option has been introduced into nightly rust somewhat recently, and was showcased in this [rust-lang article](https://blog.rust-lang.org/2023/11/09/parallel-rustc.html). This option improves multithreading in rust and speeds up compilation. I added this option to `config_fast_builds.toml` so others can also use this option to improve compile times. `-Z threads=0` automatically uses the same amount of threads as the amount of threads in your system (See [rustc source code](https://github.com/rust-lang/rust/blob/6b4f1c5e782c72a047a23e922decd33e7d462345/compiler/rustc_session/src/options.rs#L617)). ### Benchmarks > **Disclaimer:** This section was written before I knew of `-Z threads=0`, so it uses `-Z threads=8` instead. I compiled bevy with/without the `-Z threads=8` and saw about a 7% improvement in compliation times on my Kubuntu system with a 13th Gen Intel® Core™ i5-13400. Also the compile times go down over time, probably because I had other things running in the background. #### Without `-Z threads=8` - 42.33s - 40.90s - 38.27s - 38.07s - 37.17s - 37.67s - 36.63s - 37.24s **Average**: 38.535 #### With `-Z threads=8` - 36.77s - 39.50s - 38.86s - 35.61s - 34.37s - 34.32s - 34.44s - 33.74s **Average**: 35.95125
2024-01-29 23:13:22 +00:00
"-Zthreads=0", # (Nightly) Use improved multithreading with the recommended amount of threads.
Improve `config_fast_builds.toml` (#11529) # Objective Theres no explaination for what the compiler flags `config_fast_builds.toml` do ## Solution Explain what the flags in `config_fast_builds.toml` do.
2024-01-25 19:07:51 +00:00
]
add windows lld config
2020-06-01 06:18:24 +00:00
Change recommended linker: zld to lld for MacOS (#7496) # Objective Stop recommending zld on MacOS Fixes #7299 ## Solution - Add instructions to install lld for MacOS
2023-02-06 18:24:12 +00:00
# NOTE: you must install [Mach-O LLD Port](https://lld.llvm.org/MachO/index.html) on mac. you can easily do this by installing llvm which includes lld with the "brew" package manager:
# `brew install llvm`
remove specialization. bevy now builds on stable rust!
2020-06-08 06:35:40 +00:00
[target.x86_64-apple-darwin]
Change recommended linker: zld to lld for MacOS (#7496) # Objective Stop recommending zld on MacOS Fixes #7299 ## Solution - Add instructions to install lld for MacOS
2023-02-06 18:24:12 +00:00
rustflags = [
Improve `config_fast_builds.toml` (#11529) # Objective Theres no explaination for what the compiler flags `config_fast_builds.toml` do ## Solution Explain what the flags in `config_fast_builds.toml` do.
2024-01-25 19:07:51 +00:00
"-Clink-arg=-fuse-ld=/usr/local/opt/llvm/bin/ld64.lld", # Use LLD Linker
"-Zshare-generics=y", # (Nightly) Make the current crate share its generic instantiations
Use `-Z threads=0` option in `config_fast_builds.toml` (#11541) # Objective Improve compile times. ## Solution The `-Z threads=0` option has been introduced into nightly rust somewhat recently, and was showcased in this [rust-lang article](https://blog.rust-lang.org/2023/11/09/parallel-rustc.html). This option improves multithreading in rust and speeds up compilation. I added this option to `config_fast_builds.toml` so others can also use this option to improve compile times. `-Z threads=0` automatically uses the same amount of threads as the amount of threads in your system (See [rustc source code](https://github.com/rust-lang/rust/blob/6b4f1c5e782c72a047a23e922decd33e7d462345/compiler/rustc_session/src/options.rs#L617)). ### Benchmarks > **Disclaimer:** This section was written before I knew of `-Z threads=0`, so it uses `-Z threads=8` instead. I compiled bevy with/without the `-Z threads=8` and saw about a 7% improvement in compliation times on my Kubuntu system with a 13th Gen Intel® Core™ i5-13400. Also the compile times go down over time, probably because I had other things running in the background. #### Without `-Z threads=8` - 42.33s - 40.90s - 38.27s - 38.07s - 37.17s - 37.67s - 36.63s - 37.24s **Average**: 38.535 #### With `-Z threads=8` - 36.77s - 39.50s - 38.86s - 35.61s - 34.37s - 34.32s - 34.44s - 33.74s **Average**: 35.95125
2024-01-29 23:13:22 +00:00
"-Zthreads=0", # (Nightly) Use improved multithreading with the recommended amount of threads.
Change recommended linker: zld to lld for MacOS (#7496) # Objective Stop recommending zld on MacOS Fixes #7299 ## Solution - Add instructions to install lld for MacOS
2023-02-06 18:24:12 +00:00
]
remove specialization. bevy now builds on stable rust!
2020-06-08 06:35:40 +00:00
Add aarch64-apple-darwin to the config_fast_builds for Apple Silicon (#2739) # Objective M1 Macs / Apple Silicon / simply aarch64 needs to be specified for it to compile with zld, so users might be surprised to find that they aren't getting the benefits and see the fast compiles they might be seeing on other platforms. ## Solution - Add it? :)
2021-08-30 21:56:12 +00:00
[target.aarch64-apple-darwin]
Change recommended linker: zld to lld for MacOS (#7496) # Objective Stop recommending zld on MacOS Fixes #7299 ## Solution - Add instructions to install lld for MacOS
2023-02-06 18:24:12 +00:00
rustflags = [
Improve `config_fast_builds.toml` (#11529) # Objective Theres no explaination for what the compiler flags `config_fast_builds.toml` do ## Solution Explain what the flags in `config_fast_builds.toml` do.
2024-01-25 19:07:51 +00:00
"-Clink-arg=-fuse-ld=/opt/homebrew/opt/llvm/bin/ld64.lld", # Use LLD Linker
"-Zshare-generics=y", # (Nightly) Make the current crate share its generic instantiations
Use `-Z threads=0` option in `config_fast_builds.toml` (#11541) # Objective Improve compile times. ## Solution The `-Z threads=0` option has been introduced into nightly rust somewhat recently, and was showcased in this [rust-lang article](https://blog.rust-lang.org/2023/11/09/parallel-rustc.html). This option improves multithreading in rust and speeds up compilation. I added this option to `config_fast_builds.toml` so others can also use this option to improve compile times. `-Z threads=0` automatically uses the same amount of threads as the amount of threads in your system (See [rustc source code](https://github.com/rust-lang/rust/blob/6b4f1c5e782c72a047a23e922decd33e7d462345/compiler/rustc_session/src/options.rs#L617)). ### Benchmarks > **Disclaimer:** This section was written before I knew of `-Z threads=0`, so it uses `-Z threads=8` instead. I compiled bevy with/without the `-Z threads=8` and saw about a 7% improvement in compliation times on my Kubuntu system with a 13th Gen Intel® Core™ i5-13400. Also the compile times go down over time, probably because I had other things running in the background. #### Without `-Z threads=8` - 42.33s - 40.90s - 38.27s - 38.07s - 37.17s - 37.67s - 36.63s - 37.24s **Average**: 38.535 #### With `-Z threads=8` - 36.77s - 39.50s - 38.86s - 35.61s - 34.37s - 34.32s - 34.44s - 33.74s **Average**: 35.95125
2024-01-29 23:13:22 +00:00
"-Zthreads=0", # (Nightly) Use improved multithreading with the recommended amount of threads.
Change recommended linker: zld to lld for MacOS (#7496) # Objective Stop recommending zld on MacOS Fixes #7299 ## Solution - Add instructions to install lld for MacOS
2023-02-06 18:24:12 +00:00
]
Add aarch64-apple-darwin to the config_fast_builds for Apple Silicon (#2739) # Objective M1 Macs / Apple Silicon / simply aarch64 needs to be specified for it to compile with zld, so users might be surprised to find that they aren't getting the benefits and see the fast compiles they might be seeing on other platforms. ## Solution - Add it? :)
2021-08-30 21:56:12 +00:00
add windows lld config
2020-06-01 06:18:24 +00:00
[target.x86_64-pc-windows-msvc]
Use `-Z threads=0` option in `config_fast_builds.toml` (#11541) # Objective Improve compile times. ## Solution The `-Z threads=0` option has been introduced into nightly rust somewhat recently, and was showcased in this [rust-lang article](https://blog.rust-lang.org/2023/11/09/parallel-rustc.html). This option improves multithreading in rust and speeds up compilation. I added this option to `config_fast_builds.toml` so others can also use this option to improve compile times. `-Z threads=0` automatically uses the same amount of threads as the amount of threads in your system (See [rustc source code](https://github.com/rust-lang/rust/blob/6b4f1c5e782c72a047a23e922decd33e7d462345/compiler/rustc_session/src/options.rs#L617)). ### Benchmarks > **Disclaimer:** This section was written before I knew of `-Z threads=0`, so it uses `-Z threads=8` instead. I compiled bevy with/without the `-Z threads=8` and saw about a 7% improvement in compliation times on my Kubuntu system with a 13th Gen Intel® Core™ i5-13400. Also the compile times go down over time, probably because I had other things running in the background. #### Without `-Z threads=8` - 42.33s - 40.90s - 38.27s - 38.07s - 37.17s - 37.67s - 36.63s - 37.24s **Average**: 38.535 #### With `-Z threads=8` - 36.77s - 39.50s - 38.86s - 35.61s - 34.37s - 34.32s - 34.44s - 33.74s **Average**: 35.95125
2024-01-29 23:13:22 +00:00
linker = "rust-lld.exe" # Use LLD Linker
rustflags = [
Add nightly hint to config.toml (#12257) # Objective - The build on Windows currently fails on stable when using the `config.toml` as described but commenting out all lines that say "Nightly" ## Solution - Add a missing nightly specifier for a flag that won't run on stable
2024-03-02 14:41:37 +00:00
"-Zshare-generics=n", # (Nightly)
Use `-Z threads=0` option in `config_fast_builds.toml` (#11541) # Objective Improve compile times. ## Solution The `-Z threads=0` option has been introduced into nightly rust somewhat recently, and was showcased in this [rust-lang article](https://blog.rust-lang.org/2023/11/09/parallel-rustc.html). This option improves multithreading in rust and speeds up compilation. I added this option to `config_fast_builds.toml` so others can also use this option to improve compile times. `-Z threads=0` automatically uses the same amount of threads as the amount of threads in your system (See [rustc source code](https://github.com/rust-lang/rust/blob/6b4f1c5e782c72a047a23e922decd33e7d462345/compiler/rustc_session/src/options.rs#L617)). ### Benchmarks > **Disclaimer:** This section was written before I knew of `-Z threads=0`, so it uses `-Z threads=8` instead. I compiled bevy with/without the `-Z threads=8` and saw about a 7% improvement in compliation times on my Kubuntu system with a 13th Gen Intel® Core™ i5-13400. Also the compile times go down over time, probably because I had other things running in the background. #### Without `-Z threads=8` - 42.33s - 40.90s - 38.27s - 38.07s - 37.17s - 37.67s - 36.63s - 37.24s **Average**: 38.535 #### With `-Z threads=8` - 36.77s - 39.50s - 38.86s - 35.61s - 34.37s - 34.32s - 34.44s - 33.74s **Average**: 35.95125
2024-01-29 23:13:22 +00:00
"-Zthreads=0", # (Nightly) Use improved multithreading with the recommended amount of threads.
]
Speed up fast compiles config (#433) optionally make "fast build" config 40% faster on mac by removing some debug info
2020-09-04 21:09:20 +00:00
# Optional: Uncommenting the following improves compile times, but reduces the amount of debug info to 'line number tables only'
# In most cases the gains are negligible, but if you are on macos and have slow compile times you should see significant gains.
#[profile.dev]
Recommend `.cargo/config.toml` over `.cargo/config` (#459) As of Rust version 1.39.0, `config.toml` is the preferred filename for `cargo`s configuration file. Incidentally added a newline at EOF. https://doc.rust-lang.org/cargo/reference/config.html
2020-09-08 01:32:08 +00:00
#debug = 1
Reference in a new issue Copy permalink