Skip to content

Update information about debuginfo configuration #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/compiler-debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 3 additions & 5 deletions src/how-to-build-and-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`?
Expand Down
8 changes: 4 additions & 4 deletions src/profiling/with_perf.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down