itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-25 11:14:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reword intro, remove nightly/unstable feature sub-headings, clarify Cranelift backend trade-offs, remove TODO

Browse Source
This commit is contained in:
Jakub Beránek 2025-09-10 16:52:51 +02:00
parent df7e02dbf0
commit 5c1631ce62
No known key found for this signature in database
GPG Key ID: 909CD0D26483516B
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/doc/src/guide/build-performance.md
View File

@ -1,6 +1,6 @@
# Optimizing Build Performance
This guide will step you through Cargo configuration options and source code organization patterns that can help improve build performance, by prioritizing it over other aspects which may not be as important for your circumstances.
Cargo configuration options and source code organization patterns can help improve build performance, by prioritizing it over other aspects which may not be as important for your circumstances.
Same as when optimizing runtime performance, be sure to measure these changes against the workflows you actually care about, as we provide general guidelines and your circumstances may be different, it is possible that some of these approaches might actually make build performance worse for your use-case.
@ -11,8 +11,6 @@ Example workflows to consider include:
## Cargo and Compiler Configuration
> Note that some approaches described in this section currently require using the nightly toolchain.
Cargo uses configuration defaults that try to balance several aspects, including debuggability, runtime performance, build performance, binary size and others. This section describes several approaches for changing these defaults that should be designed to maximize build performance.
You can set the described options either in the [`Cargo.toml` manifest](../reference/profiles.md), which will make them available for all developers who work on the given crate/project, or in the [`config.toml` configuration file](../reference/config.md), where you can apply them only for you or even globally for all your local projects.
@ -47,8 +45,6 @@ Trade-offs:
### Use an alternative codegen backend
> **This requires nightly/unstable features**
Recommendation:
- Install the Cranelift codegen backend rustup component
@ -66,11 +62,9 @@ Recommendation:
This will change the [`dev` profile](../reference/profiles.md#dev) to use the [Cranelift codegen backend](https://github.com/rust-lang/rustc_codegen_cranelift) for generating machine code, instead of the default LLVM backend. The Cranelift backend should generate code faster than LLVM, which should result in improved build performance.
Trade-offs:
- ✅ Faster build times
- ✅ Faster code generation (`cargo build`)
- ❌ **Requires using nightly Rust and an unstable Cargo feature**
- ❌ Worse runtime performance of the generated code
- ❌ Requires using nightly Rust and an unstable feature
- Speeds up build part of `cargo test`, but might increase its test execution part
- ❌ Only available for [certain targets](https://github.com/rust-lang/rustc_codegen_cranelift?tab=readme-ov-file#platform-support)
- ❌ Might not support all Rust features (e.g. unwinding)
## Source code organization
TODO