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.

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

split-debuginfo documentation contradiction #12243

Closed
meadowsys opened this issue Apr 27, 2022 · 4 comments · Fixed by #12680
Closed

split-debuginfo documentation contradiction #12243

meadowsys opened this issue Apr 27, 2022 · 4 comments · Fixed by #12680
Labels
A-documenting-cargo-itself Area: Cargo's documentation A-profiles Area: profiles C-enhancement Category: enhancement E-easy Experience: Easy S-accepted Status: Issue or feature is accepted, and has a team member available to help mentor or review

Comments

@meadowsys
Copy link

On rustc documentation, it says that split-debuginfo is packed by default. On cargo documentation, it says that split-debuginfo is unpacked by default. Is this an accidental contradition or one of them was left outdated, or is there something that I am missing on it?

@SylvainDe
Copy link

When you "default", do you mean "default for Windows MSVC and macOS" ?

From what I can find in the history, the following changes are relevant:

@ehuss
Copy link
Contributor

ehuss commented Apr 27, 2022

The default for rustc is different from cargo.

@meadowsys
Copy link
Author

meadowsys commented Apr 27, 2022

When you "default", do you mean "default for Windows MSVC and macOS" ?

From what I can find in the history, the following changes are relevant:

hmm, I was referring specifically to the macOS defaults. I did not check Windows, since I am on a macOS machine, so I only looked at that one

The default for rustc is different from cargo.

ah, if this is the case that would make sense, so calling cargo would yield a different result than calling rustc directly if I understand correctly. If this is the case, then maybe adding a note on cargo's documentation saying that its defaults are different than rustc would be helpful?

many edits for wording, and suggesting adding a note on documentation
and another edit: oops! I forgot to specify that I was referring that specifically I noticed macOS defaults seemed to contradict

@inquisitivecrystal inquisitivecrystal added the T-cargo Team: Cargo label Apr 29, 2022
@weihanglo weihanglo transferred this issue from rust-lang/rust Jun 8, 2023
@weihanglo
Copy link
Member

Transferred to rust-lang/cargo so it won't be lost in the future.

I think it's good to have a one line notice at the end of this section. Perhaps something like

Note that Cargo and rustc might have differents defaults for split-debuginfo. This is preserved for Cargo to experiment on different combination of flags, for providing better debugging and developer experience.

@rustbot label +S-accepted +E-easy +C-bug +A-documenting-cargo-itself +A-profile -T-cargo

@weihanglo weihanglo added A-documenting-cargo-itself Area: Cargo's documentation E-easy Experience: Easy C-enhancement Category: enhancement A-profiles Area: profiles S-accepted Status: Issue or feature is accepted, and has a team member available to help mentor or review and removed T-cargo Team: Cargo labels Jun 8, 2023
@bors bors closed this as completed in b4ddf95 Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation A-profiles Area: profiles C-enhancement Category: enhancement E-easy Experience: Easy S-accepted Status: Issue or feature is accepted, and has a team member available to help mentor or review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants