fix(compiler): Clarify Finished message #13422

epage · 2024-02-08T20:14:51Z

What does this PR try to resolve?

As highlighted on zulip, many users think "Rust is slow" because of the dev profile.

While a perfect solution is still being worked out, this attempts what will hopefully be smaller, incremental step that hopefully maintains balance of the different needs.

We are changing the message from:

Finished dev [unoptimized + debuginfo] target(s) in [..]s

to

Finished `dev` profile [unoptimized + debuginfo] target(s) in [..]s

where dev profile is a link to the Cargo book.

The intent is

Clarify what dev even means
- Add profile to give it context
- Quote it to highlight this is something mutable
Make the profile content stand out on hover by being a link
Help people learn more by following the link

For now, this leaves the profile description alone.

Part of #9446

How should we test and review this PR?

Additional information

rustbot · 2024-02-08T20:14:56Z

r? @ehuss

rustbot has assigned @ehuss.
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

weihanglo · 2024-02-08T20:22:56Z

src/cargo/core/compiler/job_queue/mod.rs

            let message = format!(
-                "{} [{}] target(s) in {}",
-                profile_name, opt_type, time_elapsed
+                "{}`{profile_name}` profile{} [{opt_type}] target(s) in {time_elapsed}",


Not on topic, but we might way to make Hyperlink fancier like anstyle for open/close.

I had considered that but didn't want to include it in this PR

weihanglo

I am good with this change. Not sure if we want a quick poll.

src/cargo/core/compiler/job_queue/mod.rs

epage · 2024-02-09T03:31:21Z

I also changed the link to point directly to the built-in profile definitions so they can see what dev means and then browse further for what those fields mean.

weihanglo · 2024-02-09T03:36:17Z

I also changed the link to point directly to the built-in profile definitions so they can see what dev means and then browse further for what those fields mean.

Sounds like we can make it smarter by linking to each profile?

weihanglo · 2024-02-09T03:37:57Z

Anyway, this is a two-way door. Going to merge this.

@bors r+

bors · 2024-02-09T03:38:00Z

📌 Commit 69f38a0 has been approved by weihanglo

It is now in the queue for this repository.

bors · 2024-02-09T04:01:54Z

⌛ Testing commit 69f38a0 with merge 6283793...

bors · 2024-02-09T04:43:00Z

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 6283793 to master...

Update cargo 8 commits in ccc84ccec4b7340eb916aefda1cb3e2fe17d8e7b..fc1d58fd0531a57a6b942a14cdcdbcb82ece16f3 2024-02-07 15:37:49 +0000 to 2024-02-09 15:54:29 +0000 - docs(changelog): Clarify lints in virtual workspace error (rust-lang/cargo#13425) - fix(compiler): Clarify Finished message (rust-lang/cargo#13422) - fix(test-support): remove special case for `$message_type` (rust-lang/cargo#13424) - chore(deps): update msrv (1 version) to v1.76.0 (rust-lang/cargo#13420) - chore(bump-check): include rustfix and cargo-util-schemas (rust-lang/cargo#13421) - chore: update to `jobserver` 0.1.28 (rust-lang/cargo#13419) - feat: Add hint for adding members to workspace (rust-lang/cargo#13411) - fix: Don't duplicate comments when editing TOML (rust-lang/cargo#13402) r? weihanglo

bend-n · 2024-05-07T12:49:26Z

I dont like this change-- its rather annoying, and not very useful.
Im pretty sure a total of two people have clicked on the link intentionally (not to mention low terminal support for non XTerm feature), and the people who click on it intentionally are simply annoyed, as theres no need for this guide. Also, the pr description says that dev profile is a link, but the entirety of dev profile [unoptimized + debuginfo] is a link.

epage · 2024-05-07T14:25:04Z

@bend-n could you clarify why you find this change to be annoying? We expect to be adding a lot more links to Cargo and Rustc's outputto better connect the commands to their documentation.

as theres no need for this guide

This runs a bit counter to our experience talking to users as we found they didn't know what dev meant. Granted, also clarified it is a "profile" which also helps.

bend-n · 2024-05-07T14:38:47Z

its disruptive, as you can accidentally click on it, and in certain terminals has pop ups that are annoying. however, i have since solved my problems:

set -x FORCE_HYPERLINK 0

epage · 2024-05-07T14:42:08Z

Note that FORCE_HYPERLINK is not officially support and is a side effect of the implementation.

You should probably be using CARGO_TERM_HYPERLINKS=false

bend-n · 2024-05-07T14:52:31Z

oh, thats cool. thanks!

though, oddly, setting it in ~/.config/cargo.toml doesnt work? huh.

epage · 2024-05-07T15:01:01Z

You set

[term]
hyperlinks = false

and it didn't work?

workingjubilee · 2024-05-07T19:22:36Z

Would this be improved by shrinking the range of the hyperlink?

epage · 2024-05-07T21:27:32Z

The point of the range of the hyperlink was to cover everything profile related. The most likely alternative (what I wish I had done but hadn't felt motivated enough to implement after the PR) was to link directly to the documentation for the referenced fields, instead of one monolithic link.

Again, as I said, this also isn't expected to be isolated. Both Cargo and Rustc are looking to take advantage of more links in the output to help bridge the tool / documentation divide. Shrinking in a one off case will have little impact if we have a lot more links. Its more of needing to decide if the general vision for links needs to be adjusted and, if so, to what.

epage added 3 commits February 8, 2024 14:00

refactor(compiler): Use inline string interpolation

1906d27

fix(compiler): Clarify we're showing a profile name

e7e8d87

fix(compiler): Link people to more info about profiles

69f38a0

rustbot assigned ehuss Feb 8, 2024

epage marked this pull request as draft February 8, 2024 20:14

rustbot added A-build-execution Area: anything dealing with executing the compiler S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 8, 2024

weihanglo reviewed Feb 8, 2024

View reviewed changes

epage force-pushed the profile branch from f03c55e to f06e88d Compare February 8, 2024 20:28

epage marked this pull request as ready for review February 9, 2024 02:40

weihanglo approved these changes Feb 9, 2024

View reviewed changes

src/cargo/core/compiler/job_queue/mod.rs Outdated Show resolved Hide resolved

epage force-pushed the profile branch 2 times, most recently from c0f2ee0 to 69f38a0 Compare February 9, 2024 03:30

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 Feb 9, 2024

bors merged commit 6283793 into rust-lang:master Feb 9, 2024
21 checks passed

epage deleted the profile branch February 9, 2024 15:31

weihanglo mentioned this pull request Feb 10, 2024

Update cargo rust-lang/rust#120867

Merged

rustbot added this to the 1.78.0 milestone Feb 13, 2024

bend-n added a commit to bend-n/cargo that referenced this pull request May 7, 2024

revert rust-lang#13422

6f05bfb

bend-n added a commit to bend-n/cargo that referenced this pull request May 7, 2024

revert rust-lang#13422

1f44191

bend-n added a commit to bend-n/cargo that referenced this pull request May 7, 2024

revert rust-lang#13422

bcb71b0

bend-n added a commit to bend-n/cargo that referenced this pull request May 7, 2024

revert rust-lang#13422

5d05f00

bend-n added a commit to bend-n/cargo that referenced this pull request May 7, 2024

revert rust-lang#13422

b8466ee

bend-n added a commit to bend-n/cargo that referenced this pull request May 7, 2024

revert rust-lang#13422

b74636d

bend-n mentioned this pull request May 7, 2024

revert #13422 #13876

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(compiler): Clarify Finished message #13422

fix(compiler): Clarify Finished message #13422

epage commented Feb 8, 2024 •

edited

Loading

rustbot commented Feb 8, 2024

weihanglo Feb 8, 2024

epage Feb 8, 2024

weihanglo left a comment

epage commented Feb 9, 2024

weihanglo commented Feb 9, 2024

weihanglo commented Feb 9, 2024

bors commented Feb 9, 2024

bors commented Feb 9, 2024

bors commented Feb 9, 2024

bend-n commented May 7, 2024 •

edited

Loading

epage commented May 7, 2024

bend-n commented May 7, 2024

epage commented May 7, 2024

bend-n commented May 7, 2024 •

edited

Loading

epage commented May 7, 2024

workingjubilee commented May 7, 2024

epage commented May 7, 2024

fix(compiler): Clarify Finished message #13422

fix(compiler): Clarify Finished message #13422

Conversation

epage commented Feb 8, 2024 • edited Loading

What does this PR try to resolve?

How should we test and review this PR?

Additional information

rustbot commented Feb 8, 2024

weihanglo Feb 8, 2024

Choose a reason for hiding this comment

epage Feb 8, 2024

Choose a reason for hiding this comment

weihanglo left a comment

Choose a reason for hiding this comment

epage commented Feb 9, 2024

weihanglo commented Feb 9, 2024

weihanglo commented Feb 9, 2024

bors commented Feb 9, 2024

bors commented Feb 9, 2024

bors commented Feb 9, 2024

bend-n commented May 7, 2024 • edited Loading

epage commented May 7, 2024

bend-n commented May 7, 2024

epage commented May 7, 2024

bend-n commented May 7, 2024 • edited Loading

epage commented May 7, 2024

workingjubilee commented May 7, 2024

epage commented May 7, 2024

epage commented Feb 8, 2024 •

edited

Loading

bend-n commented May 7, 2024 •

edited

Loading

bend-n commented May 7, 2024 •

edited

Loading