Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix some typos in docs for -C split-debuginfo #83500

Merged
merged 1 commit into from
Apr 8, 2021
Merged

Fix some typos in docs for -C split-debuginfo #83500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/doc/rustc/src/codegen-options/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,27 +497,27 @@ point instructions in software. It takes one of the following values:
This option controls the emission of "split debuginfo" for debug information
that `rustc` generates. The default behavior of this option is
platform-specific, and not all possible values for this option work on all
platform. Possible values are:
platforms. Possible values are:

* `off` - This is the default for platforms with ELF binaries and windows-gnu
(not Windows MSVC and not macOS). This typically means that dwarf debug
(not Windows MSVC and not macOS). This typically means that DWARF debug
information can be found in the final artifact in sections of the executable.
This option is not supported on Windows MSVC. On macOS this options prevents
the final execution of `dsymutil` to generate debuginfo.

* `packed` - This is the default for Windows MSVC and macOS platforms. The term
* `packed` - This is the default for Windows MSVC and macOS. The term
"packed" here means that all the debug information is packed into a separate
file from the main executable. On Windows MSVC this is a `*.pdb` file, on
macOS this is a `*.dSYM` folder, and on other platforms this is a `*.dwp`
files.
file.

* `unpacked` - This means that debug information will be found in separate
files for each compilation unit (object file). This is not supported on
Windows MSVC. On macOS this means the original object files will contain
debug information. On other Unix platforms this means that `*.dwo` files will
contain debug information.

Note that `packed` and `unpacked` gated behind `-Zunstable-options` on
Note that `packed` and `unpacked` are gated behind `-Z unstable-options` on
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a space after -Z to make it easier to read. I think we use the with-space style elsewhere as well.

non-macOS platforms at this time.

## target-cpu
Expand Down