Skip to content

Commit e586544

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 86cba71 commit e586544

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

src/doc/src/reference/profiles.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -298,18 +298,27 @@ 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. The default settings for build overrides are:
304304

305305
```toml
306306
[profile.dev.build-override]
307307
opt-level = 0
308308
codegen-units = 256
309+
debug = false
309310

310311
[profile.release.build-override]
311312
opt-level = 0
312313
codegen-units = 256
314+
debug = false
315+
```
316+
317+
However, if errors occur while running build dependencies, turning full debug
318+
info on will improve backtraces and debuggability when needed:
319+
320+
```toml
321+
debug = true
313322
```
314323

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

0 commit comments

Comments
 (0)