Display valid crate types in error message for --crate-type flag #134720

malezjaa · 2024-12-24T10:09:01Z

This PR improves the error message for the --crate-type flag. When an invalid crate type is provided, the compiler will now show a list of valid options.

Before

After

I based the implementation on OutputType::shorthands_display

Closes #70183

rustbot · 2024-12-24T10:09:09Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @BoxyUwU (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

jieyouxu · 2024-12-24T14:44:23Z

I seem to recall not all the targets support all the crate types. For example, does all of the wasm targets support dylib crate type?

Example: https://github.com/rust-lang/rust/pull/130599/files#diff-ec897fdc27fe33a590c42303d7adda80b03a9af4860440e41a235d7081aa2165

Though I suppose the user will get another follow-up error anyway 😄

malezjaa · 2024-12-24T14:52:10Z

You're right 🙂 This error is just to show the valid values for --crate-type.

jieyouxu

Can you add an ui test for this diagnostics?

malezjaa · 2024-12-24T17:34:31Z

Hi, I added the tests. I'm not sure if I did it the right way, though.

src/etc/pre-push.sh

clubby789 · 2024-12-24T20:31:14Z

The UI test looks good. You'll should squash all your changes into one commit

malezjaa · 2024-12-24T20:39:58Z

Done 👍

jieyouxu

Thanks, this looks like a nice improvement, only some tiny stylistic nits, then LGTM.

compiler/rustc_session/src/config.rs

jieyouxu · 2024-12-25T10:41:49Z

Thanks, I'll r+ after PR CI is green.

jieyouxu · 2024-12-25T11:19:09Z

(You might need to rebless the test)

jieyouxu · 2024-12-25T12:40:40Z

Also, can you squash the commits into one? Thanks.

jieyouxu · 2024-12-25T19:36:17Z

Cool.
@bors r+ rollup

bors · 2024-12-25T19:36:19Z

📌 Commit b56ec2f has been approved by jieyouxu

It is now in the queue for this repository.

jieyouxu · 2024-12-29T20:32:14Z

@rustbot blocked (on rust-lang/cargo#14990 merging and also for a cargo submodule bump in this repo which contains that PR)

### What does this PR try to resolve? This PR relaxes the `bad_crate_type` test to have it only match the prefix of the unknown crate type error message emitted by rustc. This is so that the cargo test isn't sensitive to (future) suggestions for known crate types that rustc may emit to help the user. ### How should we test and review this PR? This test should already be run as part of cargo CI. (This is definitely run as part of rust-lang/rust CI, lol.) ### Additional information rust-lang/rust side PR that's trying to add a suffix to the bad crate type error message to list all valid `--crate-type` values: rust-lang/rust#134720. Without relaxing this test, the rust-lang/rust side PR [fails with](rust-lang/rust#134720 (comment)): <details> <summary>rust-lang/rust CI fail message</summary> (Ignore the missing colon after `unknown crate type`) ``` ---- bad_config::bad_crate_type stdout ---- running `/checkout/obj/build/x86_64-unknown-linux-gnu/stage2-tools/x86_64-unknown-linux-gnu/release/cargo build -v` thread 'bad_config::bad_crate_type' panicked at src/tools/cargo/tests/testsuite/bad_config.rs:434:10: ---- expected: tests/testsuite/bad_config.rs:424:27 ++++ actual: stderr 1 1 | [ERROR] failed to run `rustc` to learn about crate-type bad_type information 2 2 | 3 3 | Caused by: 4 4 | process didn't exit successfully: `rustc - --crate-name ___ --print=file-names --crate-type bad_type` ([EXIT_STATUS]: 1) 5 5 | --- stderr 6 - [ERROR] unknown crate type: `bad_type` Error: 6 + [ERROR] unknown crate type `bad_type`, expected one of: `bin`, `cdylib`, `dylib`, `lib`, `proc-macro`, `rlib` 7 7 | ``` </details> Discussed at https://rust-lang.zulipchat.com/#narrow/channel/246057-t-cargo/topic/Reblessing.20a.20cargo.20test.

malezjaa · 2024-12-29T21:12:27Z

Okay done. Sorry that it took so long. Had to rebuild it 2 times and test.

jieyouxu · 2024-12-29T21:18:15Z

There's no rush at all, we can't merge this before the cargo submodule bump which contains my cargo-side PR to merge back into this repo anyway lol.

jieyouxu

Thanks, this LGTM now, we just have to wait for the cargo submodule bump before the cargo test in this repo can pass.

compiler/rustc_session/src/config.rs

malezjaa · 2024-12-29T21:24:21Z

Oh yeah. I ran x.py test tidy. Not x.py fmt. Didn't know that. Sorry!

malezjaa · 2025-01-06T17:05:16Z

Hey @jieyouxu sorry for pinging, but I think this pr can be merged.

jieyouxu · 2025-01-06T17:23:02Z

Thanks for the reminder, I missed the cargo bump.

@bors r+ rollup

bors · 2025-01-06T17:23:05Z

📌 Commit 0d5087d has been approved by jieyouxu

It is now in the queue for this repository.

…ues, r=jieyouxu Display valid crate types in error message for --crate-type flag This PR improves the error message for the --crate-type flag. When an invalid crate type is provided, the compiler will now show a list of valid options. ### Before ![image](https://github.com/user-attachments/assets/4922e4e5-eeca-40cd-ac1c-1c6319a81aee) ### After ![image](https://github.com/user-attachments/assets/67ea1f35-aa41-4e4f-8691-47c273d0cff9) I based the implementation on `OutputType::shorthands_display` Closes rust-lang#70183

jhpratt · 2025-01-07T03:04:24Z

@bors r-

presumptive (partial) cause of #135181 (comment)

jieyouxu · 2025-01-07T08:00:16Z

Ah right, I added a new test, may have to rebless it

rust-log-analyzer · 2025-01-07T08:22:20Z

The job x86_64-gnu-llvm-18 failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

#22 exporting to docker image format
#22 sending tarball 27.0s done
#22 DONE 33.0s
##[endgroup]
Setting extra environment values for docker:  --env ENABLE_GCC_CODEGEN=1 --env GCC_EXEC_PREFIX=/usr/lib/gcc/
[CI_JOB_NAME=x86_64-gnu-llvm-18]
debug: `DISABLE_CI_RUSTC_IF_INCOMPATIBLE` configured.
---
sccache: Starting the server...
##[group]Configure the build
configure: processing command line
configure: 
configure: build.configure-args := ['--build=x86_64-unknown-linux-gnu', '--llvm-root=/usr/lib/llvm-18', '--enable-llvm-link-shared', '--set', 'rust.randomize-layout=true', '--set', 'rust.thin-lto-import-instr-limit=10', '--enable-verbose-configure', '--enable-sccache', '--disable-manage-submodules', '--enable-locked-deps', '--enable-cargo-native-static', '--set', 'rust.codegen-units-std=1', '--set', 'dist.compression-profile=balanced', '--dist-compression-formats=xz', '--set', 'rust.lld=false', '--disable-dist-src', '--release-channel=nightly', '--enable-debug-assertions', '--enable-overflow-checks', '--enable-llvm-assertions', '--set', 'rust.verify-llvm-ir', '--set', 'rust.codegen-backends=llvm,cranelift,gcc', '--set', 'llvm.static-libstdcpp', '--enable-new-symbol-mangling']
configure: target.x86_64-unknown-linux-gnu.llvm-config := /usr/lib/llvm-18/bin/llvm-config
configure: llvm.link-shared     := True
configure: rust.randomize-layout := True
configure: rust.thin-lto-import-instr-limit := 10
---

failures:

---- [ui] tests/ui/invalid-compile-flags/crate-type-flag.rs#empty_crate_type stdout ----
Saved the actual stderr to "/checkout/obj/build/x86_64-unknown-linux-gnu/test/ui/invalid-compile-flags/crate-type-flag.empty_crate_type/crate-type-flag.empty_crate_type.stderr"

- error: unknown crate type: ``
- error: unknown crate type: ``
+ error: unknown crate type: ``, expected one of: lib, rlib, staticlib, dylib, cdylib, bin, proc-macro
3 


The actual stderr differed from the expected stderr.
The actual stderr differed from the expected stderr.
To update references, rerun the tests and pass the `--bless` flag
To only update this specific test, also pass `--test-args invalid-compile-flags/crate-type-flag.rs`

error in revision `empty_crate_type`: 1 errors occurred comparing output.
status: exit status: 1
command: env -u RUSTC_LOG_COLOR RUSTC_ICE="0" RUST_BACKTRACE="short" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustc" "/checkout/tests/ui/invalid-compile-flags/crate-type-flag.rs" "-Zthreads=1" "-Zsimulate-remapped-rust-src-base=/rustc/FAKE_PREFIX" "-Ztranslate-remapped-path-to-local-path=no" "-Z" "ignore-directory-in-diagnostics-source-blocks=/cargo" "-Z" "ignore-directory-in-diagnostics-source-blocks=/checkout/vendor" "--sysroot" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2" "--target=x86_64-unknown-linux-gnu" "--cfg" "empty_crate_type" "--check-cfg" "cfg(test,FALSE,lib,rlib,staticlib,dylib,cdylib,bin,proc_dash_macro,multivalue,multivalue_combined,proc_underscore_macro,empty_crate_type,unknown)" "--error-format" "json" "--json" "future-incompat" "-Ccodegen-units=1" "-Zui-testing" "-Zdeduplicate-diagnostics=no" "-Zwrite-long-types-to-disk=no" "-Cstrip=debuginfo" "--emit" "metadata" "-C" "prefer-dynamic" "--out-dir" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/ui/invalid-compile-flags/crate-type-flag.empty_crate_type" "-A" "unused" "-A" "internal_features" "-Crpath" "-Cdebuginfo=0" "-Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--crate-type="
--- stderr -------------------------------
--- stderr -------------------------------
error: unknown crate type: ``, expected one of: lib, rlib, staticlib, dylib, cdylib, bin, proc-macro


---- [ui] tests/ui/invalid-compile-flags/crate-type-flag.rs#proc_underscore_macro stdout ----
Saved the actual stderr to "/checkout/obj/build/x86_64-unknown-linux-gnu/test/ui/invalid-compile-flags/crate-type-flag.proc_underscore_macro/crate-type-flag.proc_underscore_macro.stderr"
Saved the actual stderr to "/checkout/obj/build/x86_64-unknown-linux-gnu/test/ui/invalid-compile-flags/crate-type-flag.proc_underscore_macro/crate-type-flag.proc_underscore_macro.stderr"
diff of stderr:

- error: unknown crate type: `proc_macro`
+ error: unknown crate type: `proc_macro`, expected one of: lib, rlib, staticlib, dylib, cdylib, bin, proc-macro
3 


The actual stderr differed from the expected stderr.
The actual stderr differed from the expected stderr.
To update references, rerun the tests and pass the `--bless` flag
To only update this specific test, also pass `--test-args invalid-compile-flags/crate-type-flag.rs`

error in revision `proc_underscore_macro`: 1 errors occurred comparing output.
status: exit status: 1
command: env -u RUSTC_LOG_COLOR RUSTC_ICE="0" RUST_BACKTRACE="short" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustc" "/checkout/tests/ui/invalid-compile-flags/crate-type-flag.rs" "-Zthreads=1" "-Zsimulate-remapped-rust-src-base=/rustc/FAKE_PREFIX" "-Ztranslate-remapped-path-to-local-path=no" "-Z" "ignore-directory-in-diagnostics-source-blocks=/cargo" "-Z" "ignore-directory-in-diagnostics-source-blocks=/checkout/vendor" "--sysroot" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2" "--target=x86_64-unknown-linux-gnu" "--cfg" "proc_underscore_macro" "--check-cfg" "cfg(test,FALSE,lib,rlib,staticlib,dylib,cdylib,bin,proc_dash_macro,multivalue,multivalue_combined,proc_underscore_macro,empty_crate_type,unknown)" "--error-format" "json" "--json" "future-incompat" "-Ccodegen-units=1" "-Zui-testing" "-Zdeduplicate-diagnostics=no" "-Zwrite-long-types-to-disk=no" "-Cstrip=debuginfo" "--emit" "metadata" "-C" "prefer-dynamic" "--out-dir" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/ui/invalid-compile-flags/crate-type-flag.proc_underscore_macro" "-A" "unused" "-A" "internal_features" "-Crpath" "-Cdebuginfo=0" "-Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--crate-type=proc_macro"
--- stderr -------------------------------
--- stderr -------------------------------
error: unknown crate type: `proc_macro`, expected one of: lib, rlib, staticlib, dylib, cdylib, bin, proc-macro


---- [ui] tests/ui/invalid-compile-flags/crate-type-flag.rs#unknown stdout ----
---- [ui] tests/ui/invalid-compile-flags/crate-type-flag.rs#unknown stdout ----
Saved the actual stderr to "/checkout/obj/build/x86_64-unknown-linux-gnu/test/ui/invalid-compile-flags/crate-type-flag.unknown/crate-type-flag.unknown.stderr"

- error: unknown crate type: `🤡`
- error: unknown crate type: `🤡`
+ error: unknown crate type: `🤡`, expected one of: lib, rlib, staticlib, dylib, cdylib, bin, proc-macro
3 


The actual stderr differed from the expected stderr.
The actual stderr differed from the expected stderr.
To update references, rerun the tests and pass the `--bless` flag
To only update this specific test, also pass `--test-args invalid-compile-flags/crate-type-flag.rs`

error in revision `unknown`: 1 errors occurred comparing output.
status: exit status: 1
command: env -u RUSTC_LOG_COLOR RUSTC_ICE="0" RUST_BACKTRACE="short" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustc" "/checkout/tests/ui/invalid-compile-flags/crate-type-flag.rs" "-Zthreads=1" "-Zsimulate-remapped-rust-src-base=/rustc/FAKE_PREFIX" "-Ztranslate-remapped-path-to-local-path=no" "-Z" "ignore-directory-in-diagnostics-source-blocks=/cargo" "-Z" "ignore-directory-in-diagnostics-source-blocks=/checkout/vendor" "--sysroot" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage2" "--target=x86_64-unknown-linux-gnu" "--cfg" "unknown" "--check-cfg" "cfg(test,FALSE,lib,rlib,staticlib,dylib,cdylib,bin,proc_dash_macro,multivalue,multivalue_combined,proc_underscore_macro,empty_crate_type,unknown)" "--error-format" "json" "--json" "future-incompat" "-Ccodegen-units=1" "-Zui-testing" "-Zdeduplicate-diagnostics=no" "-Zwrite-long-types-to-disk=no" "-Cstrip=debuginfo" "--emit" "metadata" "-C" "prefer-dynamic" "--out-dir" "/checkout/obj/build/x86_64-unknown-linux-gnu/test/ui/invalid-compile-flags/crate-type-flag.unknown" "-A" "unused" "-A" "internal_features" "-Crpath" "-Cdebuginfo=0" "-Lnative=/checkout/obj/build/x86_64-unknown-linux-gnu/native/rust-test-helpers" "--crate-type=\xf0\x9f\xa4\xa1"
--- stderr -------------------------------
--- stderr -------------------------------
error: unknown crate type: `🤡`, expected one of: lib, rlib, staticlib, dylib, cdylib, bin, proc-macro



failures:

rustbot assigned BoxyUwU Dec 24, 2024

rustbot added 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 Dec 24, 2024

jieyouxu reviewed Dec 24, 2024

View reviewed changes

malezjaa requested a review from jieyouxu December 24, 2024 17:34

malezjaa force-pushed the feat/crate-type-valid-values branch from 980ca14 to 62353f8 Compare December 24, 2024 19:27

clubby789 reviewed Dec 24, 2024

View reviewed changes

src/etc/pre-push.sh Outdated Show resolved Hide resolved

malezjaa force-pushed the feat/crate-type-valid-values branch from a60dbd4 to 6315245 Compare December 24, 2024 20:39

jieyouxu assigned jieyouxu and unassigned BoxyUwU Dec 25, 2024

jieyouxu approved these changes Dec 25, 2024

View reviewed changes

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

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

jieyouxu 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 Dec 25, 2024

jieyouxu 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 Dec 25, 2024

This comment has been minimized.

Sign in to view

malezjaa force-pushed the feat/crate-type-valid-values branch from 9a2ef0a to b56ec2f Compare December 25, 2024 12:41

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 Dec 25, 2024

rustbot added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 29, 2024

malezjaa force-pushed the feat/crate-type-valid-values branch from c211549 to e20e87d Compare December 29, 2024 21:11

jieyouxu approved these changes Dec 29, 2024

View reviewed changes

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

This comment has been minimized.

Sign in to view

jieyouxu mentioned this pull request Dec 29, 2024

tests: add basic test coverage for stable --crate-type flag #134906

Merged

Display valid values in --crate-type

0d5087d

malezjaa force-pushed the feat/crate-type-valid-values branch from e20e87d to 0d5087d Compare December 29, 2024 22:12

weihanglo mentioned this pull request Dec 31, 2024

Update cargo #134987

Merged

jieyouxu 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 Jan 6, 2025

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 Jan 6, 2025

jhpratt mentioned this pull request Jan 7, 2025

Rollup of 11 pull requests #135181

Closed

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jan 7, 2025

jieyouxu closed this Jan 7, 2025

jieyouxu reopened this Jan 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Display valid crate types in error message for --crate-type flag #134720

Display valid crate types in error message for --crate-type flag #134720

malezjaa commented Dec 24, 2024 •

edited

Loading

rustbot commented Dec 24, 2024

jieyouxu commented Dec 24, 2024 •

edited

Loading

malezjaa commented Dec 24, 2024 •

edited

Loading

jieyouxu left a comment

malezjaa commented Dec 24, 2024

clubby789 commented Dec 24, 2024

malezjaa commented Dec 24, 2024

jieyouxu left a comment

jieyouxu commented Dec 25, 2024

This comment has been minimized.

jieyouxu commented Dec 25, 2024

jieyouxu commented Dec 25, 2024

jieyouxu commented Dec 25, 2024

bors commented Dec 25, 2024

jieyouxu commented Dec 29, 2024

malezjaa commented Dec 29, 2024

jieyouxu commented Dec 29, 2024

jieyouxu left a comment

This comment has been minimized.

malezjaa commented Dec 29, 2024

malezjaa commented Jan 6, 2025

jieyouxu commented Jan 6, 2025

bors commented Jan 6, 2025

jhpratt commented Jan 7, 2025

jieyouxu commented Jan 7, 2025

rust-log-analyzer commented Jan 7, 2025

Display valid crate types in error message for --crate-type flag #134720

Are you sure you want to change the base?

Display valid crate types in error message for --crate-type flag #134720

Conversation

malezjaa commented Dec 24, 2024 • edited Loading

Before

After

rustbot commented Dec 24, 2024

jieyouxu commented Dec 24, 2024 • edited Loading

malezjaa commented Dec 24, 2024 • edited Loading

jieyouxu left a comment

Choose a reason for hiding this comment

malezjaa commented Dec 24, 2024

clubby789 commented Dec 24, 2024

malezjaa commented Dec 24, 2024

jieyouxu left a comment

Choose a reason for hiding this comment

jieyouxu commented Dec 25, 2024

This comment has been minimized.

jieyouxu commented Dec 25, 2024

jieyouxu commented Dec 25, 2024

jieyouxu commented Dec 25, 2024

bors commented Dec 25, 2024

jieyouxu commented Dec 29, 2024

malezjaa commented Dec 29, 2024

jieyouxu commented Dec 29, 2024

jieyouxu left a comment

Choose a reason for hiding this comment

This comment has been minimized.

malezjaa commented Dec 29, 2024

malezjaa commented Jan 6, 2025

jieyouxu commented Jan 6, 2025

bors commented Jan 6, 2025

jhpratt commented Jan 7, 2025

jieyouxu commented Jan 7, 2025

rust-log-analyzer commented Jan 7, 2025

malezjaa commented Dec 24, 2024 •

edited

Loading

jieyouxu commented Dec 24, 2024 •

edited

Loading

malezjaa commented Dec 24, 2024 •

edited

Loading