rustdoc: Gate unstable `doc(cfg())` predicates #138293

clubby789 · 2025-03-09T23:46:31Z

Since the extraction process treats cfg(true) as having no cfg attribute, we have to do the gating during parsing; so we remove the unused features arg from Cfg::matches

rustbot · 2025-03-09T23:46:34Z

r? @notriddle

rustbot has assigned @notriddle.
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

tests/rustdoc/doc-cfg-unstable.rs

notriddle · 2025-03-22T03:22:28Z

I’ve been getting unexpected work, and not very familiar with this code anyway.

r? @GuillaumeGomez

GuillaumeGomez · 2025-03-22T10:24:29Z

Thanks!

@bors r+ rollup

bors · 2025-03-22T10:24:32Z

📌 Commit 85b1116 has been approved by GuillaumeGomez

It is now in the queue for this repository.

…eGomez rustdoc: Gate unstable `doc(cfg())` predicates Fixes rust-lang#138113 Since the extraction process treats `cfg(true)` as having no cfg attribute, we have to do the gating during parsing; so we remove the unused `features` arg from `Cfg::matches`

Rollup of 9 pull requests Successful merges: - rust-lang#138236 (uefi: Add OwnedEvent abstraction) - rust-lang#138293 (rustdoc: Gate unstable `doc(cfg())` predicates) - rust-lang#138509 (Add test to ensure no index out of bounds panic (rust-lang#135474)) - rust-lang#138602 (Slim `rustc_parse_format` dependencies down) - rust-lang#138631 (Update test for SGX now implementing `read_buf`) - rust-lang#138641 (Add unstable `--print=supported-crate-types` option) - rust-lang#138662 (Implement some basics in UEFI fs) - rust-lang#138837 (resolve: Avoid remaining unstable iteration) - rust-lang#138849 (doc: rename reference #create-a-configtoml to #create-a-bootstraptoml) Failed merges: - rust-lang#138755 ([rustdoc] Remove duplicated loop when computing doc cfgs) r? `@ghost` `@rustbot` modify labels: rollup

…eGomez rustdoc: Gate unstable `doc(cfg())` predicates Fixes rust-lang#138113 Since the extraction process treats `cfg(true)` as having no cfg attribute, we have to do the gating during parsing; so we remove the unused `features` arg from `Cfg::matches`

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#138236 (uefi: Add OwnedEvent abstraction) - rust-lang#138293 (rustdoc: Gate unstable `doc(cfg())` predicates) - rust-lang#138509 (Add test to ensure no index out of bounds panic (rust-lang#135474)) - rust-lang#138631 (Update test for SGX now implementing `read_buf`) - rust-lang#138662 (Implement some basics in UEFI fs) - rust-lang#138837 (resolve: Avoid remaining unstable iteration) - rust-lang#138849 (doc: rename reference #create-a-configtoml to #create-a-bootstraptoml) r? `@ghost` `@rustbot` modify labels: rollup

…eGomez rustdoc: Gate unstable `doc(cfg())` predicates Fixes rust-lang#138113 Since the extraction process treats `cfg(true)` as having no cfg attribute, we have to do the gating during parsing; so we remove the unused `features` arg from `Cfg::matches`

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#138236 (uefi: Add OwnedEvent abstraction) - rust-lang#138293 (rustdoc: Gate unstable `doc(cfg())` predicates) - rust-lang#138509 (Add test to ensure no index out of bounds panic (rust-lang#135474)) - rust-lang#138631 (Update test for SGX now implementing `read_buf`) - rust-lang#138837 (resolve: Avoid remaining unstable iteration) - rust-lang#138849 (doc: rename reference #create-a-configtoml to #create-a-bootstraptoml) r? `@ghost` `@rustbot` modify labels: rollup

…mpiler-errors Rollup of 12 pull requests Successful merges: - rust-lang#136040 (Remove unused trait BoundedSize) - rust-lang#138236 (uefi: Add OwnedEvent abstraction) - rust-lang#138293 (rustdoc: Gate unstable `doc(cfg())` predicates) - rust-lang#138509 (Add test to ensure no index out of bounds panic (rust-lang#135474)) - rust-lang#138545 (Add MIR pre-codegen tests to track rust-lang#138544) - rust-lang#138631 (Update test for SGX now implementing `read_buf`) - rust-lang#138641 (Add unstable `--print=supported-crate-types` option) - rust-lang#138667 (std: uefi: fs: Implement mkdir) - rust-lang#138849 (doc: rename reference #create-a-configtoml to #create-a-bootstraptoml) - rust-lang#138854 (Fix ICE rust-lang#138415 for invalid extern function body) - rust-lang#138858 (Say which test failed the `COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS` assertion) - rust-lang#138861 (Tweak type flags, fix missing flags from coroutine kind ty) Failed merges: - rust-lang#138755 ([rustdoc] Remove duplicated loop when computing doc cfgs) r? `@ghost` `@rustbot` modify labels: rollup

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#138236 (uefi: Add OwnedEvent abstraction) - rust-lang#138293 (rustdoc: Gate unstable `doc(cfg())` predicates) - rust-lang#138509 (Add test to ensure no index out of bounds panic (rust-lang#135474)) - rust-lang#138631 (Update test for SGX now implementing `read_buf`) - rust-lang#138837 (resolve: Avoid remaining unstable iteration) - rust-lang#138849 (doc: rename reference #create-a-configtoml to #create-a-bootstraptoml) r? `@ghost` `@rustbot` modify labels: rollup

…mpiler-errors Rollup of 12 pull requests Successful merges: - rust-lang#136040 (Remove unused trait BoundedSize) - rust-lang#138236 (uefi: Add OwnedEvent abstraction) - rust-lang#138293 (rustdoc: Gate unstable `doc(cfg())` predicates) - rust-lang#138509 (Add test to ensure no index out of bounds panic (rust-lang#135474)) - rust-lang#138545 (Add MIR pre-codegen tests to track rust-lang#138544) - rust-lang#138631 (Update test for SGX now implementing `read_buf`) - rust-lang#138641 (Add unstable `--print=supported-crate-types` option) - rust-lang#138667 (std: uefi: fs: Implement mkdir) - rust-lang#138849 (doc: rename reference #create-a-configtoml to #create-a-bootstraptoml) - rust-lang#138854 (Fix ICE rust-lang#138415 for invalid extern function body) - rust-lang#138858 (Say which test failed the `COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS` assertion) - rust-lang#138861 (Tweak type flags, fix missing flags from coroutine kind ty) Failed merges: - rust-lang#138755 ([rustdoc] Remove duplicated loop when computing doc cfgs) r? `@ghost` `@rustbot` modify labels: rollup

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#138236 (uefi: Add OwnedEvent abstraction) - rust-lang#138293 (rustdoc: Gate unstable `doc(cfg())` predicates) - rust-lang#138509 (Add test to ensure no index out of bounds panic (rust-lang#135474)) - rust-lang#138631 (Update test for SGX now implementing `read_buf`) - rust-lang#138837 (resolve: Avoid remaining unstable iteration) - rust-lang#138849 (doc: rename reference #create-a-configtoml to #create-a-bootstraptoml) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#138293 - clubby789:doc-cfg-gate, r=GuillaumeGomez rustdoc: Gate unstable `doc(cfg())` predicates Fixes rust-lang#138113 Since the extraction process treats `cfg(true)` as having no cfg attribute, we have to do the gating during parsing; so we remove the unused `features` arg from `Cfg::matches`

…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](rust-lang/rfcs#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](rust-lang#131034). ### Summarize existing test coverage of this feature - [Basic usage, including `#[cfg()]`, `cfg!()` and `#[cfg_attr()]`](https://github.com/rust-lang/rust/blob/6d71251cf9e40326461f90f8ff9a7024706aea87/tests/ui/cfg/true-false.rs) - [`--cfg=true/false` on the command line being accessible via `r#true/r#false`](https://github.com/rust-lang/rust/blob/6d71251cf9e40326461f90f8ff9a7024706aea87/tests/ui/cfg/raw-true-false.rs) - [Interaction with the unstable `#[doc(cfg(..))]` feature](https://github.com/rust-lang/rust/tree/6d71251/tests/rustdoc-ui/cfg-boolean-literal.rs) - [Denying `--check-cfg=cfg(true/false)`](https://github.com/rust-lang/rust/tree/6d71251/tests/ui/check-cfg/invalid-arguments.rs) - 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.

Rollup merge of rust-lang#138632 - clubby789:stabilize-cfg-boolean-lit, 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](rust-lang/rfcs#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](rust-lang#131034). ### Summarize existing test coverage of this feature - [Basic usage, including `#[cfg()]`, `cfg!()` and `#[cfg_attr()]`](https://github.com/rust-lang/rust/blob/6d71251cf9e40326461f90f8ff9a7024706aea87/tests/ui/cfg/true-false.rs) - [`--cfg=true/false` on the command line being accessible via `r#true/r#false`](https://github.com/rust-lang/rust/blob/6d71251cf9e40326461f90f8ff9a7024706aea87/tests/ui/cfg/raw-true-false.rs) - [Interaction with the unstable `#[doc(cfg(..))]` feature](https://github.com/rust-lang/rust/tree/6d71251/tests/rustdoc-ui/cfg-boolean-literal.rs) - [Denying `--check-cfg=cfg(true/false)`](https://github.com/rust-lang/rust/tree/6d71251/tests/ui/check-cfg/invalid-arguments.rs) - 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.

rustbot assigned notriddle Mar 9, 2025

clubby789 added the F-doc_cfg `#![feature(doc_cfg)]` label Mar 9, 2025

Urgau reviewed Mar 10, 2025

View reviewed changes

tests/rustdoc/doc-cfg-unstable.rs Outdated Show resolved Hide resolved

tests/rustdoc/doc-cfg-unstable.rs Outdated Show resolved Hide resolved

rustdoc: Gate unstable doc(cfg()) predicates

28bd22c

rust-cloud-vms bot force-pushed the doc-cfg-gate branch from d2b27a0 to 28bd22c Compare March 10, 2025 15:45

This comment has been minimized.

Sign in to view

clubby789 mentioned this pull request Mar 11, 2025

#[doc(cfg(..)] does not respect check-cfg #138358

Open

rustdoc: Add FIXME test for doc_cfg interaction with check_cfg

85b1116

rust-cloud-vms bot force-pushed the doc-cfg-gate branch from d2c53b7 to 85b1116 Compare March 11, 2025 17:03

clubby789 removed the T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. label Mar 11, 2025

This was referenced Mar 17, 2025

Tracking issue for RFC 3695: Allow boolean literals as cfg predicates #131204

Closed

Stabilize cfg_boolean_literals #138632

Merged

rustbot assigned GuillaumeGomez and unassigned notriddle Mar 22, 2025

GuillaumeGomez approved these changes Mar 22, 2025

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 22, 2025

This was referenced Mar 23, 2025

Rollup of 9 pull requests #138853

Closed

[rustdoc] Remove duplicated loop when computing doc cfgs #138755

Merged

matthiaskrgr mentioned this pull request Mar 23, 2025

Rollup of 7 pull requests #138856

Closed

matthiaskrgr mentioned this pull request Mar 23, 2025

Rollup of 6 pull requests #138859

Closed

compiler-errors mentioned this pull request Mar 23, 2025

Rollup of 12 pull requests #138866

Merged

bors merged commit 856ba39 into rust-lang:master Mar 24, 2025
6 checks passed

rustbot added this to the 1.87.0 milestone Mar 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

rustdoc: Gate unstable `doc(cfg())` predicates #138293

rustdoc: Gate unstable `doc(cfg())` predicates #138293

Uh oh!

clubby789 commented Mar 9, 2025

Uh oh!

rustbot commented Mar 9, 2025

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

notriddle commented Mar 22, 2025

Uh oh!

GuillaumeGomez commented Mar 22, 2025

Uh oh!

bors commented Mar 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

rustdoc: Gate unstable doc(cfg()) predicates #138293

rustdoc: Gate unstable doc(cfg()) predicates #138293

Uh oh!

Conversation

clubby789 commented Mar 9, 2025

Uh oh!

rustbot commented Mar 9, 2025

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

notriddle commented Mar 22, 2025

Uh oh!

GuillaumeGomez commented Mar 22, 2025

Uh oh!

bors commented Mar 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

rustdoc: Gate unstable `doc(cfg())` predicates #138293

rustdoc: Gate unstable `doc(cfg())` predicates #138293