Skip to content

Conversation

@epage
Copy link
Contributor

@epage epage commented Jan 23, 2026

What does this PR try to resolve?

Name and styling was inspired by
redundant_static_lifetimes

Fixes #15869

How to test and review this PR?

@rustbot rustbot added A-manifest Area: Cargo.toml issues A-workspaces Area: workspaces S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 23, 2026
@rustbot
Copy link
Collaborator

rustbot commented Jan 23, 2026

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

@epage epage changed the title Redundant readme feat(lint): Add redundant_readme lint Jan 23, 2026
r#"
### What it does

Checks for `package.readme` fields that can be inferred
Copy link
Member

Choose a reason for hiding this comment

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

Is there any canonical docs we can link to about the redundancy?

Copy link
Member

Choose a reason for hiding this comment

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

Relative link maybe?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

While it would be good to have a relative link for https://doc.rust-lang.org/cargo/reference/lints.html, I'm operating under the assumption that we'll eventually render this in other places, like in cargo --explain.

Copy link
Member

Choose a reason for hiding this comment

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

We can fix that when we implement cargo --explain. Or we should update below to follow the pattern here:

(the [default requirements](specifying-dependencies.md#default-requirements)).

@rustbot rustbot added the A-documenting-cargo-itself Area: Cargo's documentation label Jan 23, 2026
@rustbot
Copy link
Collaborator

rustbot commented Jan 23, 2026

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.

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.

@weihanglo weihanglo added this pull request to the merge queue Jan 23, 2026
Merged via the queue into rust-lang:master with commit a2a76a5 Jan 23, 2026
29 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 23, 2026
@epage epage deleted the redundant_readme branch January 25, 2026 03:50
rust-bors bot pushed a commit to rust-lang/rust that referenced this pull request Jan 28, 2026
Update cargo submodule

11 commits in efcd9f58636c1990393d495159045d9c35e43b8f..0f3a1e9099aecdf95f144e842d96dc1827c1985
2026-01-23 13:50:59 +0000 to 2026-01-27 20:14:45 +0000

- feat(lints): Add redundant_homepage lint  (rust-lang/cargo#16561)
- feat(lints): Add `non_*_case_features` (rust-lang/cargo#16560)
- Update build_std::basic test to ensure index doesn't update (rust-lang/cargo#16559)
- feat(lints): Add mutually exclusive `non_{kebab,snake}_case_packages` (rust-lang/cargo#16554)
- fix(lints): Pluralize non_kebab_case_bins (rust-lang/cargo#16553)
- Add -Z json-target-spec (rust-lang/cargo#16557)
- feat(lint): Add redundant_readme lint  (rust-lang/cargo#16552)
- chore(deps): update msrv (rust-lang/cargo#16387)
- tests: add regression test for --artifact-dir on stable (rust-lang/cargo#16541)
- Don't check the specific build-std output (rust-lang/cargo#16551)
- Fix build-std lto test to run on other platforms (rust-lang/cargo#16550)
rust-bors bot pushed a commit to rust-lang/rust that referenced this pull request Jan 29, 2026
Update cargo submodule

11 commits in efcd9f58636c1990393d495159045d9c35e43b8f..0f3a1e9099aecdf95f144e842d96dc1827c1985
2026-01-23 13:50:59 +0000 to 2026-01-27 20:14:45 +0000

- feat(lints): Add redundant_homepage lint  (rust-lang/cargo#16561)
- feat(lints): Add `non_*_case_features` (rust-lang/cargo#16560)
- Update build_std::basic test to ensure index doesn't update (rust-lang/cargo#16559)
- feat(lints): Add mutually exclusive `non_{kebab,snake}_case_packages` (rust-lang/cargo#16554)
- fix(lints): Pluralize non_kebab_case_bins (rust-lang/cargo#16553)
- Add -Z json-target-spec (rust-lang/cargo#16557)
- feat(lint): Add redundant_readme lint  (rust-lang/cargo#16552)
- chore(deps): update msrv (rust-lang/cargo#16387)
- tests: add regression test for --artifact-dir on stable (rust-lang/cargo#16541)
- Don't check the specific build-std output (rust-lang/cargo#16551)
- Fix build-std lto test to run on other platforms (rust-lang/cargo#16550)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-documenting-cargo-itself Area: Cargo's documentation A-manifest Area: Cargo.toml issues A-workspaces Area: workspaces

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Lint if explicit package.readme could be inferred

4 participants