Description
Proposal
The --check-cfg
flag allows rustc
to lint on unexpected cfgs in source code, but source code is not the only place where cfgs appear and are used.
They also appear in:
--cfg
flags, which we ignore (for now) becauseRUSTFLAGS
applies to all crates- and in
Cargo.toml
with conditional keys[target.'cfg(windows)'.dependencies] libc = "0.2"
The way Cargo checks if the windows
cfg is enabled is by using the --print=cfg
flag, which prints all enabled cfgs, so Cargo only needs to check if the cfg is present in the output or not.
I therefore propose that we (unstably) add the corollary to --print=cfg
by adding --print=check-cfg
, so that Cargo can then lint over those unexpected cfgs.
This new print option would work similarly to --print=cfg
(modulo check-cfg specifics):
- check_cfg syntax: output of --print
cfg(windows)
:windows
cfg(feature, values("foo", "bar"))
:feature="foo"
andfeature="bar"
cfg(feature, values(none(), ""))
:feature
andfeature=""
cfg(feature, values(any()))
:feature=any()
cfg(any())
:any()
- nothing:
any()=any()
Aside from the potential Cargo use, regular users might also want a way to see the list of expected cfgs, either for debugging or verifying things or whatever.
Mentors or Reviewers
@Urgau (for the implementation)
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.
- Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a
- 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.