Skip to content

Commit 79a15d6

Browse files
committed
update build dependencies profiles documentation
This describes the new defaults for build-overrides, and how to make sure backtraces have the usual debug info, when needed.
1 parent 76585f4 commit 79a15d6

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

src/doc/src/reference/profiles.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -298,18 +298,28 @@ The `bench` profile inherits the settings from the [`release`](#release) profile
298298

299299
#### Build Dependencies
300300

301-
All profiles, by default, do not optimize build dependencies (build scripts,
302-
proc macros, and their dependencies). The default settings for build overrides
303-
are:
301+
To compile quickly, all profiles, by default, do not optimize build
302+
dependencies (build scripts, proc macros, and their dependencies), and avoid
303+
computing debug info when a build dependency is not used as a runtime
304+
dependency. The default settings for build overrides are:
304305

305306
```toml
306307
[profile.dev.build-override]
307308
opt-level = 0
308309
codegen-units = 256
310+
debug = false # when possible
309311

310312
[profile.release.build-override]
311313
opt-level = 0
312314
codegen-units = 256
315+
debug = false # when possible
316+
```
317+
318+
However, if errors occur while running build dependencies, turning full debug
319+
info on will improve backtraces and debuggability when needed:
320+
321+
```toml
322+
debug = true
313323
```
314324

315325
Build dependencies otherwise inherit settings from the active profile in use, as

0 commit comments

Comments
 (0)