Skip to content

Commit

Permalink
Document debuginfo defaults and link to rustc's docs
Browse files Browse the repository at this point in the history
Co-authored-by: Scott Schafer <[email protected]>
  • Loading branch information
jyn514 and Muscraft authored Apr 21, 2023
1 parent a982bcc commit 5a2f6e5
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/doc/src/reference/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,13 @@ amount of debug information included in the compiled binary.

The valid options are:

* `0`, `false`, or `"none"`: no debug info at all
* `0`, `false`, or `"none"`: no debug info at all, default for [`release`](https://doc.rust-lang.org/cargo/reference/profiles.html#release)
* `"line-directives-only"`: line info directives only. For the nvptx* targets this enables [profiling](https://reviews.llvm.org/D46061). For other use cases, `line-tables-only` is the better, more compatible choice.
* `"line-tables-only"`: line tables only. Generates the minimal amount of debug info for backtraces with filename/line number info, but not anything else, i.e. no variable or function parameter info.
* `1` or `"limited"`: debug info without type or variable-level information. Generates more detailed module-level info than `line-tables-only`.
* `2`, `true`, or `"full"`: full debug info
* `2`, `true`, or `"full"`: full debug info, default for [`dev`](https://doc.rust-lang.org/cargo/reference/profiles.html#dev)

For more information on what each option does see `rustc`'s docs on [debuginfo](https://doc.rust-lang.org/rustc/codegen-options/index.html#debuginfo)

You may wish to also configure the [`split-debuginfo`](#split-debuginfo) option
depending on your needs as well.
Expand Down

0 comments on commit 5a2f6e5

Please sign in to comment.