rustdoc: Gate unstable doc(cfg()) predicates by clubby789 · Pull Request #138293 · rust-lang/rust (original) (raw)

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request

Apr 17, 2025

…t, r=davidtwco,Urgau,traviscross

Stabilize cfg_boolean_literals

Closes rust-lang#131204 @rustbot labels +T-lang +I-lang-nominated This will end up conflicting with the test in rust-lang#138293 so whichever doesn't land first will need updating

--

Stabilization Report

General design

What is the RFC for this feature and what changes have occurred to the user-facing design since the RFC was finalized?

RFC 3695, none.

What behavior are we committing to that has been controversial? Summarize the major arguments pro/con.

None

Are there extensions to this feature that remain unstable? How do we know that we are not accidentally committing to those?

None

Has a call-for-testing period been conducted? If so, what feedback was received?

Yes; only positive feedback was received.

Implementation quality

Summarize the major parts of the implementation and provide links into the code (or to PRs)

Implemented in rust-lang#131034.

Summarize existing test coverage of this feature

• Basic usage, including #[cfg()], cfg!() and #[cfg_attr()]
• --cfg=true/false on the command line being accessible via r#true/r#false
• Interaction with the unstable #[doc(cfg(..))] feature
• Denying --check-cfg=cfg(true/false)
• Ensuring --cfg false on the command line doesn't change the meaning of cfg(false): tests/ui/cfg/cmdline-false.rs
• Ensuring both cfg(true) and cfg(false) on the same item result in it being disabled: tests/ui/cfg/both-true-false.rs

What outstanding bugs in the issue tracker involve this feature? Are they stabilization-blocking?

The above mentioned issue; it should not block as it interacts with another unstable feature.

What FIXMEs are still in the code for that feature and why is it ok to leave them there?

None

Summarize contributors to the feature by name for recognition and assuredness that people involved in the feature agree with stabilization

• @clubby789 (RFC)
• @Urgau (Implementation in rustc)

Which tools need to be adjusted to support this feature. Has this work been done?

rustdoc's unstable#[doc(cfg(..)] has been updated to respect it. cargo has been updated with a forward compatibility lint to enable supporting it in cargo once stabilized.

Type system and execution rules

What updates are needed to the reference/specification? (link to PRs when they exist)

A few lines to be added to the reference for configuration predicates, specified in the RFC.