Skip to content

Commit bcef848

Browse files
Explain effects of debugging options from config.toml
Co-authored-by: Teymour Aldridge <[email protected]>
1 parent 0cd7ff7 commit bcef848

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

config.toml.example

+6-2
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,9 @@
318318
#codegen-units-std = 1
319319

320320
# Whether or not debug assertions are enabled for the compiler and standard
321-
# library.
321+
# library. Debug assertions control the maximum log level used by rustc. When
322+
# enabled calls to `trace!` and `debug!` macros are preserved in the compiled
323+
# binary, otherwise they are omitted.
322324
#
323325
# Defaults to rust.debug value
324326
#debug-assertions = false
@@ -331,7 +333,9 @@
331333

332334
# Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
333335
# `0` - no debug info
334-
# `1` - line tables only
336+
# `1` - line tables only - sufficient to generate backtraces that include line
337+
# information and inlined functions, set breakpoints at source code
338+
# locations, and step through execution in a debugger.
335339
# `2` - full debug info with variable and type information
336340
# Can be overridden for specific subsets of Rust code (rustc, std or tools).
337341
# Debuginfo for tests run with compiletest is not controlled by this option

0 commit comments

Comments
 (0)