Confusing documentation regarding defaults for the strip configuration
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 15.5k
- Forks
- 3k
- Avg merge
- 23h 30m
- Merged PRs (30d)
- 51
Description
Problem
Cargo documentation for the strip options says that the default option for strip is strip = "none". The same strip = "none" is written for the definition of the default Cargo Release profile here.
However, since Rust 1.77 Cargo changed logic for in a way that by default (for almost all cases, I would say) the current default is strip = "debuginfo".
This behaviour shall be documented in a right way in the documentation.
Steps
No response
Possible Solution(s)
Fix the documentation
Notes
No response
Version
Latest
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Cargo profiles documentation sections for the strip option and the default Release profile, then compare their wording with the Rust 1.77 release announcement linked in the issue. Update the documentation so the documented defaults accurately describe current Cargo behavior, including the relevant default stripping mode.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100