Unify the format of rustc cli flags #140152

xizheyin · 2025-04-22T07:44:15Z

As mentioned in #140102, I unified the format of rustc CLI flags.

I use the following rules:

<param>: Indicates a required parameter
[param]: Indicates an optional parameter
|: Indicates a mutually exclusive option
*: a list element with description

Current output:

Usage: rustc [OPTIONS] INPUT

Options:
    -h, --help          Display this message
        --cfg <SPEC>    Configure the compilation environment.
                        SPEC supports the syntax `<NAME>[="<VALUE>"]`.
        --check-cfg <SPEC>
                        Provide list of expected cfgs for checking
    -L [<KIND>=]<PATH>  Add a directory to the library search path. The
                        optional KIND can be one of
                        <dependency|crate|native|framework|all> (default:
                        all).
    -l [<KIND>[:<MODIFIERS>]=]<NAME>[:<RENAME>]
                        Link the generated crate(s) to the specified native
                        library NAME. The optional KIND can be one of
                        <static|framework|dylib> (default: dylib).
                        Optional comma separated MODIFIERS
                        <bundle|verbatim|whole-archive|as-needed>
                        may be specified each with a prefix of either '+' to
                        enable or '-' to disable.
        --crate-type <bin|lib|rlib|dylib|cdylib|staticlib|proc-macro>
                        Comma separated list of types of crates
                        for the compiler to emit
        --crate-name <NAME>
                        Specify the name of the crate being built
        --edition <2015|2018|2021|2024|future>
                        Specify which edition of the compiler to use when
                        compiling code. The default is 2015 and the latest
                        stable edition is 2024.
        --emit <TYPE>[=<FILE>]
                        Comma separated list of types of output for the
                        compiler to emit.
                        Each TYPE has the default FILE name:
                        * asm - CRATE_NAME.s
                        * llvm-bc - CRATE_NAME.bc
                        * dep-info - CRATE_NAME.d
                        * link - (platform and crate-type dependent)
                        * llvm-ir - CRATE_NAME.ll
                        * metadata - libCRATE_NAME.rmeta
                        * mir - CRATE_NAME.mir
                        * obj - CRATE_NAME.o
                        * thin-link-bitcode - CRATE_NAME.indexing.o
        --print <INFO>[=<FILE>]
                        Compiler information to print on stdout (or to a file)
                        INFO may be one of
                        <all-target-specs-json|calling-conventions|cfg|check-cfg|code-models|crate-name|crate-root-lint-levels|deployment-target|file-names|host-tuple|link-args|native-static-libs|relocation-models|split-debuginfo|stack-protector-strategies|supported-crate-types|sysroot|target-cpus|target-features|target-libdir|target-list|target-spec-json|tls-models>.
    -g                  Equivalent to -C debuginfo=2
    -O                  Equivalent to -C opt-level=3
    -o <FILENAME>       Write output to FILENAME
        --out-dir <DIR> Write output to compiler-chosen filename in DIR
        --explain <OPT> Provide a detailed explanation of an error message
        --test          Build a test harness
        --target <TARGET>
                        Target triple for which the code is compiled
    -A, --allow <LINT>  Set lint allowed
    -W, --warn <LINT>   Set lint warnings
        --force-warn <LINT>
                        Set lint force-warn
    -D, --deny <LINT>   Set lint denied
    -F, --forbid <LINT> Set lint forbidden
        --cap-lints <LEVEL>
                        Set the most restrictive lint level. More restrictive
                        lints are capped at this level
    -C, --codegen <OPT>[=<VALUE>]
                        Set a codegen option
    -V, --version       Print version info and exit
    -v, --verbose       Use verbose output

Additional help:
    -C help             Print codegen options
    -W help             Print 'lint' options and default settings
    -Z help             Print unstable compiler options
    --help -v           Print the full set of options rustc accepts

rustbot · 2025-04-22T07:44:21Z

r? @jieyouxu

rustbot has assigned @jieyouxu.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2025-04-22T07:44:23Z

This PR modifies run-make tests.

cc @jieyouxu

jieyouxu · 2025-04-22T07:51:20Z

I'll review this after #140077 merges. Afterwards, can you double-check if the rustc book and the unstable book has places that still use the previous styles? Don't need to rush to change those yet, I haven't looked closely if the proposed scheme

<param>: Indicates a required parameter
[param]: Indicates an optional parameter
|: Indicates a mutually exclusive option

has any conflicts or whatever.

jieyouxu · 2025-04-22T07:51:56Z

Please flip this PR back to ready once #140077 merges.

@rustbot blocked (#140077)

jieyouxu · 2025-04-22T07:53:45Z

Just kidding, it just merged.
@rustbot review

xizheyin · 2025-04-22T07:54:34Z

haha, it's a bit of a coincidence. I will resolve the conflicts.

xizheyin · 2025-04-22T08:15:25Z

@rustbot author

rustbot · 2025-04-22T08:15:30Z

Reminder, once the PR becomes ready for a review, use @rustbot ready.

xizheyin · 2025-04-22T08:46:56Z

I resolved the conflicts, and checked through the rustc book and the unstable book.

There are two flags in rustc book following the old styles(if I didn't ignore any places):

Flags in unstable book are almostly in line with this spec, such as 1 and 2. They are not presented as the HELP style, while in the style presenting some example, such as -Z patchable-function-entry=total_nops,prefix_nops.

@rustbot ready

compiler/rustc_session/src/config.rs

compiler/rustc_span/src/edition.rs

compiler/rustc_session/src/config.rs

Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn>

jieyouxu

Thanks, I think this is a nice consistency improvement. One comment nit.

compiler/rustc_session/src/config.rs

jieyouxu · 2025-04-25T08:58:35Z

@rustbot author

Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn>

xizheyin · 2025-04-25T11:38:59Z

No problem, I added doc comment.
@rustbot ready

jieyouxu

Thanks

jieyouxu · 2025-04-25T11:42:18Z

@bors r+ rollup

bors · 2025-04-25T11:42:21Z

📌 Commit 999b906 has been approved by jieyouxu

It is now in the queue for this repository.

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#137683 (Add a tidy check for GCC submodule version) - rust-lang#138968 (Update the index of Result to make the summary more comprehensive) - rust-lang#139572 (docs(std): mention const blocks in const keyword doc page) - rust-lang#140152 (Unify the format of rustc cli flags) - rust-lang#140193 (fix ICE in `#[naked]` attribute validation) - rust-lang#140205 (Tidying up UI tests [2/N]) - rust-lang#140284 (remove expect() in `unnecessary_transmutes`) - rust-lang#140290 (rustdoc: fix typo change from equivelent to equivalent) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#140152 - xizheyin:issue-140102, r=jieyouxu Unify the format of rustc cli flags As mentioned in rust-lang#140102, I unified the format of rustc CLI flags. I use the following rules: 1. `<param>`: Indicates a required parameter 2. `[param]`: Indicates an optional parameter 3. `|`: Indicates a mutually exclusive option 4. `*`: a list element with description Current output: ```bash Usage: rustc [OPTIONS] INPUT Options: -h, --help Display this message --cfg <SPEC> Configure the compilation environment. SPEC supports the syntax `<NAME>[="<VALUE>"]`. --check-cfg <SPEC> Provide list of expected cfgs for checking -L [<KIND>=]<PATH> Add a directory to the library search path. The optional KIND can be one of <dependency|crate|native|framework|all> (default: all). -l [<KIND>[:<MODIFIERS>]=]<NAME>[:<RENAME>] Link the generated crate(s) to the specified native library NAME. The optional KIND can be one of <static|framework|dylib> (default: dylib). Optional comma separated MODIFIERS <bundle|verbatim|whole-archive|as-needed> may be specified each with a prefix of either '+' to enable or '-' to disable. --crate-type <bin|lib|rlib|dylib|cdylib|staticlib|proc-macro> Comma separated list of types of crates for the compiler to emit --crate-name <NAME> Specify the name of the crate being built --edition <2015|2018|2021|2024|future> Specify which edition of the compiler to use when compiling code. The default is 2015 and the latest stable edition is 2024. --emit <TYPE>[=<FILE>] Comma separated list of types of output for the compiler to emit. Each TYPE has the default FILE name: * asm - CRATE_NAME.s * llvm-bc - CRATE_NAME.bc * dep-info - CRATE_NAME.d * link - (platform and crate-type dependent) * llvm-ir - CRATE_NAME.ll * metadata - libCRATE_NAME.rmeta * mir - CRATE_NAME.mir * obj - CRATE_NAME.o * thin-link-bitcode - CRATE_NAME.indexing.o --print <INFO>[=<FILE>] Compiler information to print on stdout (or to a file) INFO may be one of <all-target-specs-json|calling-conventions|cfg|check-cfg|code-models|crate-name|crate-root-lint-levels|deployment-target|file-names|host-tuple|link-args|native-static-libs|relocation-models|split-debuginfo|stack-protector-strategies|supported-crate-types|sysroot|target-cpus|target-features|target-libdir|target-list|target-spec-json|tls-models>. -g Equivalent to -C debuginfo=2 -O Equivalent to -C opt-level=3 -o <FILENAME> Write output to FILENAME --out-dir <DIR> Write output to compiler-chosen filename in DIR --explain <OPT> Provide a detailed explanation of an error message --test Build a test harness --target <TARGET> Target triple for which the code is compiled -A, --allow <LINT> Set lint allowed -W, --warn <LINT> Set lint warnings --force-warn <LINT> Set lint force-warn -D, --deny <LINT> Set lint denied -F, --forbid <LINT> Set lint forbidden --cap-lints <LEVEL> Set the most restrictive lint level. More restrictive lints are capped at this level -C, --codegen <OPT>[=<VALUE>] Set a codegen option -V, --version Print version info and exit -v, --verbose Use verbose output Additional help: -C help Print codegen options -W help Print 'lint' options and default settings -Z help Print unstable compiler options --help -v Print the full set of options rustc accepts ```

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#137683 (Add a tidy check for GCC submodule version) - rust-lang#138968 (Update the index of Result to make the summary more comprehensive) - rust-lang#139572 (docs(std): mention const blocks in const keyword doc page) - rust-lang#140152 (Unify the format of rustc cli flags) - rust-lang#140193 (fix ICE in `#[naked]` attribute validation) - rust-lang#140205 (Tidying up UI tests [2/N]) - rust-lang#140284 (remove expect() in `unnecessary_transmutes`) - rust-lang#140290 (rustdoc: fix typo change from equivelent to equivalent) r? `@ghost` `@rustbot` modify labels: rollup

* For `nightly` Rust (and 1.88+), the output format of `--help` was changed in rust-lang/rust#140152. This PR changes the parser to parse the new format, so that edition overrides are selectable for `nightly` Rust. Note the `<>`: ``` --edition <2015|2018|2021|2024|future> Specify which edition of the compiler to use when compiling code. The default is 2015 and the latest stable edition is 2024. ``` * Rust <= 1.34 (and >= 1.31) support the 2018 edition, but the help message only includes `--edition` in verbose mode.

rustbot assigned jieyouxu Apr 22, 2025

rustbot added A-run-make Area: port run-make Makefiles to rmake.rs S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Apr 22, 2025

rustbot added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 22, 2025

jieyouxu added the A-CLI Area: Command-line interface (CLI) to the compiler label Apr 22, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Apr 22, 2025

xizheyin force-pushed the issue-140102 branch from 0f829fc to a85a758 Compare April 22, 2025 08:11

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 22, 2025

xizheyin force-pushed the issue-140102 branch from a85a758 to 3aa870e Compare April 22, 2025 08:24

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 22, 2025

fmease reviewed Apr 22, 2025

View reviewed changes

compiler/rustc_session/src/config.rs Outdated Show resolved Hide resolved

fmease reviewed Apr 22, 2025

View reviewed changes

compiler/rustc_span/src/edition.rs Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

xizheyin force-pushed the issue-140102 branch from 1d4dd15 to 9e8692a Compare April 22, 2025 11:01

bjorn3 reviewed Apr 22, 2025

View reviewed changes

compiler/rustc_session/src/config.rs Outdated Show resolved Hide resolved

Unify the format of rustc cli flags

d054690

Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn>

xizheyin force-pushed the issue-140102 branch from 9e8692a to d054690 Compare April 24, 2025 04:54

jieyouxu approved these changes Apr 25, 2025

View reviewed changes

compiler/rustc_session/src/config.rs Show resolved Hide resolved

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 25, 2025

Add option style comment for rustc_optgroups

999b906

Signed-off-by: xizheyin <xizheyin@smail.nju.edu.cn>

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 25, 2025

jieyouxu approved these changes Apr 25, 2025

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 25, 2025

matthiaskrgr mentioned this pull request Apr 25, 2025

Rollup of 8 pull requests #140298

Merged

bors merged commit eb225e3 into rust-lang:master Apr 25, 2025
6 checks passed

rustbot added this to the 1.88.0 milestone Apr 25, 2025

narpfel mentioned this pull request May 4, 2025

Fix Rust edition argument parser compiler-explorer/compiler-explorer#7652

Merged

Unify the format of rustc cli flags #140152

Unify the format of rustc cli flags #140152

Uh oh!

Conversation

xizheyin commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Apr 22, 2025

Uh oh!

rustbot commented Apr 22, 2025

Uh oh!

jieyouxu commented Apr 22, 2025

Uh oh!

jieyouxu commented Apr 22, 2025

Uh oh!

jieyouxu commented Apr 22, 2025

Uh oh!

xizheyin commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xizheyin commented Apr 22, 2025

Uh oh!

rustbot commented Apr 22, 2025

Uh oh!

xizheyin commented Apr 22, 2025

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

jieyouxu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jieyouxu commented Apr 25, 2025

Uh oh!

xizheyin commented Apr 25, 2025

Uh oh!

jieyouxu left a comment

Choose a reason for hiding this comment

Uh oh!

jieyouxu commented Apr 25, 2025

Uh oh!

bors commented Apr 25, 2025

Uh oh!

Uh oh!

Uh oh!

xizheyin commented Apr 22, 2025 •

edited

Loading

xizheyin commented Apr 22, 2025 •

edited

Loading