Skip to content

Conversation

epage
Copy link
Contributor

@epage epage commented Sep 9, 2025

What does this PR try to resolve?

Switches a multi-line note to use annotate_snippet directly in prep for #15917 where these extra lines will be aligned with the first line.

How to test and review this PR?

Notes

Unsure if this should be two groups or one group with a message.

If its one group, then we'll have a decorative line and then the help:
will be further indented.

I went with what is closer to how we do things today. We can always
re-evaluate at a later point.

@rustbot rustbot added A-interacts-with-crates.io Area: interaction with registries Command-publish S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 9, 2025
@rustbot
Copy link
Collaborator

rustbot commented Sep 9, 2025

r? @weihanglo

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

Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two groups looks better to in this case.

@epage
Copy link
Contributor Author

epage commented Sep 10, 2025

We may want to wait until rust-lang/annotate-snippets-rs#310

Unsure if this should be two groups or one group with a message.

If its one group, then we'll have a decorative line and then the `help:`
will be further indented.

I went with what is closer to how we do things today.  We can always
re-evaluate at a later point.
@epage
Copy link
Contributor Author

epage commented Sep 11, 2025

We may want to wait until rust-lang/annotate-snippets-rs#310

That is merged and this PR is updated. This should be good to go forward

@weihanglo weihanglo added this pull request to the merge queue Sep 12, 2025
Merged via the queue into rust-lang:master with commit 4f2f1d7 Sep 12, 2025
27 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 12, 2025
@epage epage deleted the ctrl-c branch September 12, 2025 13:47
@weihanglo
Copy link
Member

Unsure if this should be two groups or one group with a message.

If its one group, then we'll have a decorative line and then the help:
will be further indented.

Bumped into this today from rustc, so maybe one group matches rustc more?

warning: the gold linker is deprecated and has known bugs with Rust
  |
  = help: consider using LLD or ld from GNU binutils instead

bors added a commit to rust-lang/rust that referenced this pull request Sep 17, 2025
Update cargo submodule

19 commits in 24bb93c388fb8c211a37986539f24a819dc669d3..966f94733bbc94ca51ff9f1e4c49ad250ebbdc50
2025-09-10 23:16:07 +0000 to 2025-09-16 17:24:45 +0000
- fix(frontmatter): Improve error quality (rust-lang/cargo#15972)
- fix: wrong variable name in documentation (rust-lang/cargo#15968)
- Add "Optimizing Build Performance" section to the Cargo book (rust-lang/cargo#15924)
- Remove extra apostrophe in environment-variables.md (rust-lang/cargo#15963)
- Clarify warning for using `features` or `default-features` in `patch` (rust-lang/cargo#15953)
- fix(frontmatter): Try alternative len code fences (rust-lang/cargo#15952)
- feat(cli): Allow completions for third-party subcommand names (rust-lang/cargo#15961)
- docs(index): Clarify what we mean by omitting features (rust-lang/cargo#15957)
- fix(future): Report all content as a single Report (rust-lang/cargo#15943)
- fix(complete): Show local crates/features over other members  (rust-lang/cargo#15956)
- docs(resolver): Describe the role of the lockfile  (rust-lang/cargo#15958)
- chore: Skip check-version-bump ci job in forks (rust-lang/cargo#15959)
- Eliminate the last three "did you mean" warning phrasings (rust-lang/cargo#15356)
- fix(info): Suggest a more universal `cargo tree` command (rust-lang/cargo#15954)
- feat(cli): Use ellipses when truncating progress (rust-lang/cargo#15955)
- feat(completer): Added completion for `--features` flag (rust-lang/cargo#15309)
- fix(publish): Switch the 'ctrl-c on wait' line to a help message (rust-lang/cargo#15942)
- docs: move docs building process to contributor guide (rust-lang/cargo#15854)
- fix(manifest): Show error source to users (rust-lang/cargo#15939)

r? ghost
@rustbot rustbot added this to the 1.92.0 milestone Sep 17, 2025
@epage
Copy link
Contributor Author

epage commented Sep 17, 2025

My intention with going with separate groups for now are

  • Partially transitioned to having that padding will be inconsistent, let's switch to annotate snippets and then evaluate
  • The padding line only exists between the primary title and the first group member and not other group members but some of our reports are really more of secondary titles or group members to something else (like cargo news note after the creation message)
  • We need to figure out general guidelines for when to have second groups vs messages in a group

@weihanglo
Copy link
Member

Those points are reasonable. Thanks!

Also, regarding the group message, if https://github.com/rust-lang/cargo/pull/15953/files#r2346621001 were one group, the instead would make a bit more sense, just like the linker help message.

(I don't know if we want to create a ticket tracking these discussions though, maybe?)

@epage
Copy link
Contributor Author

epage commented Sep 17, 2025

Maybe worth commenting on the tracking issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-interacts-with-crates.io Area: interaction with registries Command-publish
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants