Skip to content

Commit a3391a4

Browse files
committed
Auto merge of #9224 - ehuss:split-debuginfo-docs, r=Eh2406
Update split-debuginfo docs around the default. The default behavior was changed during the course PR #9112, but the docs weren't updated. Closes #9218
2 parents ccf781a + c8e27b9 commit a3391a4

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

src/doc/src/reference/profiles.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,12 @@ controls whether debug information, if generated, is either placed in the
8383
executable itself or adjacent to it.
8484

8585
This option is a string and acceptable values are the same as those the
86-
[compiler accepts][`-C split-debuginfo` flag]. This option is currently not
87-
passed by default on platforms other than macOS, where it defaults to
88-
`unpacked`. The default may change in the future for platforms using DWARF
89-
debugging information and ELF executables to `unpacked` as well once it is
90-
stabilized in the compiler.
86+
[compiler accepts][`-C split-debuginfo` flag]. See that documentation for the
87+
default behavior, which is platform-specific. Some options are only available
88+
on the [nightly channel]. The default may change in the future once more
89+
testing has been performed, and support for DWARF is stabilized.
9190

91+
[nightly channel]: ../../book/appendix-07-nightly-rust.html
9292
[`-C split-debuginfo` flag]: ../../rustc/codegen-options/index.html#split-debuginfo
9393

9494
#### debug-assertions
@@ -230,6 +230,7 @@ The default settings for the `dev` profile are:
230230
[profile.dev]
231231
opt-level = 0
232232
debug = true
233+
split-debuginfo = '...' # Platform-specific.
233234
debug-assertions = true
234235
overflow-checks = true
235236
lto = false
@@ -251,6 +252,7 @@ The default settings for the `release` profile are:
251252
[profile.release]
252253
opt-level = 3
253254
debug = false
255+
split-debuginfo = '...' # Platform-specific.
254256
debug-assertions = false
255257
overflow-checks = false
256258
lto = false
@@ -271,6 +273,7 @@ The default settings for the `test` profile are:
271273
[profile.test]
272274
opt-level = 0
273275
debug = 2
276+
split-debuginfo = '...' # Platform-specific.
274277
debug-assertions = true
275278
overflow-checks = true
276279
lto = false
@@ -291,6 +294,7 @@ The default settings for the `bench` profile are:
291294
[profile.bench]
292295
opt-level = 3
293296
debug = false
297+
split-debuginfo = '...' # Platform-specific.
294298
debug-assertions = false
295299
overflow-checks = false
296300
lto = false

0 commit comments

Comments
 (0)