about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorVadim Petrochenkov <vadim.petrochenkov@gmail.com>2019-05-31 13:54:39 +0400
committerWho? Me?! <mark-i-m@users.noreply.github.com>2019-06-02 19:36:58 -0500
commit85601df5ef705d2c4b261e7f134549228942f19b (patch)
tree8187c08d35e625de463e5f9f520bda90b432722b /src/doc/rustc-dev-guide
parent19022db2d43c3789d34252db9780304bc8aff4f8 (diff)
downloadrust-85601df5ef705d2c4b261e7f134549228942f19b.tar.gz
rust-85601df5ef705d2c4b261e7f134549228942f19b.zip
Update information about debuginfo configuration
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/compiler-debugging.md2
-rw-r--r--src/doc/rustc-dev-guide/src/how-to-build-and-run.md8
-rw-r--r--src/doc/rustc-dev-guide/src/profiling/with_perf.md8
3 files changed, 8 insertions, 10 deletions
diff --git a/src/doc/rustc-dev-guide/src/compiler-debugging.md b/src/doc/rustc-dev-guide/src/compiler-debugging.md
index db7f08e4655..304f75d802a 100644
--- a/src/doc/rustc-dev-guide/src/compiler-debugging.md
+++ b/src/doc/rustc-dev-guide/src/compiler-debugging.md
@@ -47,7 +47,7 @@ stack backtrace:
 ```
 
 If you want line numbers for the stack trace, you can enable
-`debuginfo-lines=true` or `debuginfo=true` in your config.toml and rebuild the
+`debuginfo-level = 1` or `debuginfo-level = 2` in your config.toml and rebuild the
 compiler. Then the backtrace will look like this:
 
 ```text
diff --git a/src/doc/rustc-dev-guide/src/how-to-build-and-run.md b/src/doc/rustc-dev-guide/src/how-to-build-and-run.md
index 4eb4023c4ec..d0ba0ea57f2 100644
--- a/src/doc/rustc-dev-guide/src/how-to-build-and-run.md
+++ b/src/doc/rustc-dev-guide/src/how-to-build-and-run.md
@@ -36,11 +36,9 @@ debug-assertions = true
 # performance perhaps (less inlining) but it's worth it.
 codegen-units = 0
 
-# I always enable full debuginfo, though debuginfo-lines is more important.
-debuginfo = true
-
-# Gives you line numbers for backtraces.
-debuginfo-lines = true
+# I always enable full debuginfo, however the line debuginfo (which is a more important part
+# and enables e.g. line numbers in backtraces) is enabled by `debuginfo-level = 1` too.
+debuginfo-level = 2
 ```
 
 ### What is `x.py`?
diff --git a/src/doc/rustc-dev-guide/src/profiling/with_perf.md b/src/doc/rustc-dev-guide/src/profiling/with_perf.md
index 25889940029..2634cc2601a 100644
--- a/src/doc/rustc-dev-guide/src/profiling/with_perf.md
+++ b/src/doc/rustc-dev-guide/src/profiling/with_perf.md
@@ -7,15 +7,15 @@ This is a guide for how to profile rustc with [perf](https://perf.wiki.kernel.or
 - Get a clean checkout of rust-lang/master, or whatever it is you want
   to profile.
 - Set the following settings in your `config.toml`:
-  - `debuginfo-lines = true`
-  - `use-jemalloc = false` — lets you do memory use profiling with valgrind 
+  - `debuginfo-level = 1` - enables line debuginfo
+  - `use-jemalloc = false` - lets you do memory use profiling with valgrind
   - leave everything else the defaults
 - Run `./x.py build` to get a full build
 - Make a rustup toolchain pointing to that result
   - see [the "build and run" section for instructions][b-a-r]
 
 [b-a-r]: ../how-to-build-and-run.html#toolchain
-  
+
 ## Gathering a perf profile
 
 perf is an excellent tool on linux that can be used to gather and
@@ -295,7 +295,7 @@ altogether ("total") and the percent of time spent in **just that
 function and not some callee of that function** (self). Usually
 "total" is the more interesting number, but not always.
 
-### Relative percentages 
+### Relative percentages
 
 By default, all in perf-focus are relative to the **total program
 execution**. This is useful to help you keep perspective — often as