Consider renaming `debug` to `debuginfo` in profiles
Open
Nobody has claimed this yet.
A-debugging
A-profiles
C-feature-request
S-needs-mentor
- Dominant language
- Rust
- Stars
- 15.5k
- Forks
- 3k
- Avg merge
- 23h 30m
- Merged PRs (30d)
- 51
Description
In profiles, one can use
debug = true # Controls whether the compiler passes -g
The name debug is confounding (at least for me):
- It says nothing about "symbols",
- It implies "slower code", which is false,
- It can be confused with "debug-assertions".
Obviously we can't just rename debug to generate-symbols, but we can add an alias and update docs.
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 by locating Cargo's profile configuration handling and the documentation for the debug profile option. Review how profile aliases are represented and how -g is described; done means supporting the proposed alias and updating the relevant documentation without removing the existing option.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100