about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTomasz Miąsko <tomasz.miasko@gmail.com>2020-07-05 00:00:00 +0000
committerTomasz Miąsko <tomasz.miasko@gmail.com>2020-07-05 11:37:39 +0200
commitbcef848a6971217d4b8df50c17e047174018d316 (patch)
tree791269d40c66f198302b7186be46eec303edeb30
parent0cd7ff7ddfb75a38dca81ad3e76b1e984129e939 (diff)
downloadrust-bcef848a6971217d4b8df50c17e047174018d316.tar.gz
rust-bcef848a6971217d4b8df50c17e047174018d316.zip
Explain effects of debugging options from config.toml
Co-authored-by: Teymour Aldridge <42674621+teymour-aldridge@users.noreply.github.com>
-rw-r--r--config.toml.example8
1 files changed, 6 insertions, 2 deletions
diff --git a/config.toml.example b/config.toml.example
index 2fa613755d6..79e4e46d85b 100644
--- a/config.toml.example
+++ b/config.toml.example
@@ -318,7 +318,9 @@
 #codegen-units-std = 1
 
 # Whether or not debug assertions are enabled for the compiler and standard
-# library.
+# library. Debug assertions control the maximum log level used by rustc. When
+# enabled calls to `trace!` and `debug!` macros are preserved in the compiled
+# binary, otherwise they are omitted.
 #
 # Defaults to rust.debug value
 #debug-assertions = false
@@ -331,7 +333,9 @@
 
 # Debuginfo level for most of Rust code, corresponds to the `-C debuginfo=N` option of `rustc`.
 # `0` - no debug info
-# `1` - line tables only
+# `1` - line tables only - sufficient to generate backtraces that include line
+#       information and inlined functions, set breakpoints at source code
+#       locations, and step through execution in a debugger.
 # `2` - full debug info with variable and type information
 # Can be overridden for specific subsets of Rust code (rustc, std or tools).
 # Debuginfo for tests run with compiletest is not controlled by this option