Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable warn(unused_crate_dependencies) on rustc_*` crates #844

Open
1 of 3 tasks
nnethercote opened this issue Mar 3, 2025 · 2 comments
Open
1 of 3 tasks

Enable warn(unused_crate_dependencies) on rustc_*` crates #844

nnethercote opened this issue Mar 3, 2025 · 2 comments
Labels
final-comment-period The FCP has started, most (if not all) team members are in agreement major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team

Comments

@nnethercote
Copy link

nnethercote commented Mar 3, 2025

Proposal

It's bad having unused dependencies in Cargo.toml files. There's probably some kind of compile time cost, but more importantly, it's just misleading when reading the code.[*]

In the past I have looked for unused dependencies in a brute force fashion: comment out all dependencies in a Cargo.toml file, and then add them back in until it compiles again. This works but is slow and tedious.

Then I learned the unused_crate_dependencies lint, which is much better. In rust-lang/rust#126063 I removed 19 unused dependencies that I found by changing unused_crate_dependencies from Allow to Warn. But there were a few false positives so doing this everywhere didn't seem feasible.

Today I redid this exercise and found another 15 unused dependencies that had crept in over the past nine months. (And I recently removed another two in rust-lang/rust#137776 that I found with my own eyeballs.) Based on that, I think it's worth pushing harder on enabling this lint for the compiler.

I propose adding warn(unused_crate_dependencies) to all rustc_* crates, except for those where the lint gives false positives, which would instead get allow(unused_crate_dependencies) along with an explanatory comment.

(An alternative is to pass -Wunused-crate-dependencies to all rustc_* crates. That would require touching fewer lines, and would also automatically extend the functionality to new crates.)

[*] Something I look at quite often is a graph of the crate dependencies, generated with these commands:

cargo +nightly depgraph --all-deps --dedup-transitive-deps --workspace-only > ~/graph.dot;
dot -Tpng ~/graph.dot > ~/graph.png

Here is an example one:
Image

It's good to not have unused edges in this graph.

Mentors or Reviewers

None. Two possible PRs implementing this are at rust-lang/rust#137911 and rust-lang/rust#137930.

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

@nnethercote nnethercote added major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team labels Mar 3, 2025
@rustbot
Copy link
Collaborator

rustbot commented Mar 3, 2025

Important

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

Concerns or objections to the proposal should be discussed on Zulip and formally registered here by adding a comment with the following syntax:

@rfcbot concern reason-for-concern 
<description of the concern> 

Concerns can be lifted with:

@rfcbot resolve reason-for-concern 

See documentation at https://forge.rust-lang.org

cc @rust-lang/compiler

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Mar 3, 2025
@oli-obk
Copy link
Contributor

oli-obk commented Mar 3, 2025

@rustbot second

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label Mar 3, 2025
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Mar 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
final-comment-period The FCP has started, most (if not all) team members are in agreement major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team
Projects
None yet
Development

No branches or pull requests

4 participants