Skip to content

Commit 5a2f6e5

Browse files
jyn514Muscraft
andauthored
Document debuginfo defaults and link to rustc's docs
Co-authored-by: Scott Schafer <[email protected]>
1 parent a982bcc commit 5a2f6e5

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/doc/src/reference/profiles.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,13 @@ amount of debug information included in the compiled binary.
6767

6868
The valid options are:
6969

70-
* `0`, `false`, or `"none"`: no debug info at all
70+
* `0`, `false`, or `"none"`: no debug info at all, default for [`release`](https://doc.rust-lang.org/cargo/reference/profiles.html#release)
7171
* `"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.
7272
* `"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.
7373
* `1` or `"limited"`: debug info without type or variable-level information. Generates more detailed module-level info than `line-tables-only`.
74-
* `2`, `true`, or `"full"`: full debug info
74+
* `2`, `true`, or `"full"`: full debug info, default for [`dev`](https://doc.rust-lang.org/cargo/reference/profiles.html#dev)
75+
76+
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)
7577

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

0 commit comments

Comments
 (0)