Consider unifying how rustc cli flag values are presented
Open
Nobody has claimed this yet.
A-CLI
A-diagnostics
C-enhancement
T-compiler
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
Not necessarily for this PR, but I think we should settle on a consistent way of listing out sets of alternatives like this across our options. We currently have
- Exhaustively listed in command (
--crate-type [bin|lib|rlib|...])- Listed in help in parentheses (
INFO may be one of (all-target-specs-json|calling-conventions|...))- Listed in help as a textual list (
The KIND can be one of dependency, crate, native, framework, or all (the default).)
With this being a fourth potential layout
Originally posted by @clubby789 in https://github.com/rust-lang/rust/pull/140077#discussion_r2051821994
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 at the rustc CLI flag help and option descriptions, using the four alternative-listing examples in the issue as the comparison set. Determine the scope of a consistent presentation and record which existing forms should change; done means the project has an agreed convention and an identified set of affected options.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, compilers
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100