Skip to content

fix(cargo_common_metadata): stop checking package.readme - #17643

Merged
rustbot merged 1 commit into
rust-lang:masterfrom
weihanglo:manual-readme
Aug 28, 2026
Merged

fix(cargo_common_metadata): stop checking package.readme#17643
rustbot merged 1 commit into
rust-lang:masterfrom
weihanglo:manual-readme

Conversation

@weihanglo

@weihanglo weihanglo commented Aug 27, 2026

Copy link
Copy Markdown
Member

Cargo infers standard README filenames,
and the new cargo lint cargo::manual_readme warns when the field is redundantly set.

We simply just remove the check,
as most of the cargo lints in clippy will slowly be deprecated and migrated to cargo.

See

changelog: [cargo_common_metadata]: No longer checks for package.readme metadata field

My friend's cat
image

@rustbot rustbot added the S-waiting-on-community-reviews Status: This is awaiting for positive reviews from the community before a maintainer is assigned. label Aug 27, 2026
@rustbot

rustbot commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the pull request. A reviewer will take a look after it receives 2 community reviews.

In the meantime, we would highly appreciate if you could try to review any of PRs waiting on community reviews.

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Aug 27, 2026
@rustbot

This comment has been minimized.

Sign in to view
@weihanglo

weihanglo commented Aug 27, 2026

Copy link
Copy Markdown
Member Author

cc also rust-lang/rust#161789

@github-actions

github-actions Bot commented Aug 27, 2026 •
edited
Loading

Copy link
Copy Markdown

Lintcheck changes for bd3a0cf

Lint Added Removed Changed
clippy::cargo_common_metadata 0 16 82

This comment will be updated if you push new changes

hashcatHitman
hashcatHitman approved these changes Aug 27, 2026
View reviewed changes

@hashcatHitman hashcatHitman left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

community review:

Looks good to me.

View changes since this review

CommanderStorm
CommanderStorm approved these changes Aug 28, 2026
View reviewed changes

@CommanderStorm CommanderStorm left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

community review: makes sense

View changes since this review

@rustbot rustbot removed the S-waiting-on-community-reviews Status: This is awaiting for positive reviews from the community before a maintainer is assigned. label Aug 28, 2026
@rustbot

rustbot commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

r? @Jarcho

rustbot has assigned @Jarcho for the project review.
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

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: 9 candidates
  • 9 candidates expanded to 9 candidates
  • Random selection from Jarcho, Manishearth, blyxyas, dswij, llogiq

ada4a
ada4a approved these changes Aug 28, 2026
View reviewed changes

@ada4a ada4a left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

That works:)

I'll let @Jarcho have a final say though

View changes since this review

@rustbot

This comment has been minimized.

Sign in to view
@weihanglo
fix(cargo_common_metadata): stop checking package.readme
bd3a0cf 
Cargo infers standard README filenames,
and the new cargo lint `cargo::manual_readme` warns
when the field is redundantly set.

We simply just remove the check, as most of the cargo lints in clippy
will slowly be deprecated and migrated to cargo.

See

* https://doc.rust-lang.org/nightly/cargo/reference/lints.html#manual_readme
* Issue rust-clippy#17635
@rustbot

rustbot commented Aug 28, 2026

Copy link
Copy Markdown
Collaborator

This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

Jarcho
Jarcho approved these changes Aug 28, 2026
View reviewed changes

@Jarcho Jarcho left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you.

@rustbot merge

View changes since this review

@rustbot
rustbot added this pull request to the merge queue Aug 28, 2026
Merged via the queue into rust-lang:master with commit 3211e31 Aug 28, 2026
11 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties label Aug 28, 2026
@weihanglo
weihanglo deleted the manual-readme branch August 28, 2026 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Jarcho Jarcho Jarcho approved these changes
@ada4a ada4a ada4a approved these changes
+2 more reviewers
@CommanderStorm CommanderStorm CommanderStorm approved these changes
@hashcatHitman hashcatHitman hashcatHitman approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@Jarcho Jarcho

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

cargo::manual_readme lint's behavior conflicts with clippy::cargo-common-metadata

6 participants

@weihanglo @rustbot @Jarcho @CommanderStorm @ada4a @hashcatHitman