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

Internal lint: Ban pub re-exports in compiler/ #368

Closed
1 of 3 tasks
jyn514 opened this issue Oct 3, 2020 · 5 comments
Closed
1 of 3 tasks

Internal lint: Ban pub re-exports in compiler/ #368

jyn514 opened this issue Oct 3, 2020 · 5 comments
Labels
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

@jyn514
Copy link
Member

jyn514 commented Oct 3, 2020

Proposal

This is an MCP for rust-lang/rust#65233 (Internal lint: Ban pub re-exports)

Why make this change?

  • re-exports obscure which crate an item is defined in
  • re-exports add non-canonical paths: should I import rustc_hir::def_id::LOCAL_CRATE or rustc_span::def_id::LOCAL_CRATE?
  • re-exports can add unnecessary dependencies to the crate graph, slowing down compile times (due to lack of parallelism) and making refactors more difficult

What is the long-term goal?

The long-term goal is to split up rustc_middle as per rust-lang/rust#65031. I'm thinking of doing that by moving out rustc_middle::ty to rustc_ty, but I'm not set on that; accepting this MCP should not count as accepting the rustc_middle change.

Why not make this change?

  • Churn
  • You now have to care where items are defined when you didn't before.

Proposed approach

  • Deny public re-exports by default.
  • Allow public re-exports in the following crates/modules:

There is a half-finished implementation of this in rust-lang/rust#77479.

Mentors or Reviewers

I am not sure who should mentor. Perhaps @lcnr is interested?

Process

The main points of the Major Change Process is 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.

Comments

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.

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

rustbot commented Oct 3, 2020

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.

@lcnr
Copy link
Contributor

lcnr commented Oct 3, 2020

Can mentor/review, but not a member of t-compiler, so I don't think I can second this.

@lcnr
Copy link
Contributor

lcnr commented Oct 3, 2020

compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.

didn't realize contributors can also second 😅

@rustbot second

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label Oct 3, 2020
@spastorino spastorino removed the to-announce Announce this issue on triage meeting label Oct 8, 2020
@petrochenkov
Copy link

petrochenkov commented Oct 8, 2020

Looks like this is currently in FCP to accept, but one PR applying a subset of this proposal was recently closed - rust-lang/rust#77494.
So it seems like this suggestion should rather be done on case by case basis, than as a general policy.

@jyn514
Copy link
Member Author

jyn514 commented Oct 8, 2020

Sounds good to me.

@jyn514 jyn514 closed this as completed Oct 8, 2020
@apiraino apiraino removed the final-comment-period The FCP has started, most (if not all) team members are in agreement label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

6 participants