Skip to content

Stabilize doc_cfg feature #150055

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.

Sign up for GitHub

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

Jump to bottom
Open
GuillaumeGomez wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Stabilize doc_cfg feature #150055

GuillaumeGomez wants to merge 1 commit into from
+314 −485

Conversation

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Dec 16, 2025 •
edited
Loading

Fixes #43781.

The feature has been around for some time and I think it's now ok to stabilize it.

cc @rust-lang/rustdoc

@rustbot
Copy link
Collaborator

rustbot commented Dec 16, 2025

stdarch is developed in its own repository. If possible, consider making this change to rust-lang/stdarch instead.

cc @Amanieu, @folkertdev, @sayantn

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Dec 16, 2025
@rustbot
Copy link
Collaborator

rustbot commented Dec 16, 2025

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

@GuillaumeGomez GuillaumeGomez mentioned this pull request Dec 16, 2025
Open
6 tasks
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-log-analyzer
Copy link
Collaborator

rust-log-analyzer commented Dec 16, 2025

The job aarch64-gnu-llvm-20-2 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot) 
##[endgroup]
[TIMING:end] tool::ToolBuild { build_compiler: Compiler { stage: 0, host: aarch64-unknown-linux-gnu, forced_compiler: false }, target: aarch64-unknown-linux-gnu, tool: "linkchecker", path: "src/tools/linkchecker", mode: ToolBootstrap, source_type: InTree, extra_features: [], allow_features: "", cargo_args: [], artifact_kind: Binary } -- 0.150
[TIMING:end] tool::Linkchecker { compiler: Compiler { stage: 0, host: aarch64-unknown-linux-gnu, forced_compiler: false }, target: aarch64-unknown-linux-gnu } -- 0.000
##[group]Testing stage1 Linkcheck (aarch64-unknown-linux-gnu)
cargo/print.html:4456: broken link - `unstable-book/language-features/doc-cfg.html`
cargo/reference/features.html:564: broken link - `unstable-book/language-features/doc-cfg.html`
checked links in: 22.9s
number of HTML files scanned: 46418
number of HTML redirects found: 14548
number of links checked: 2562616
number of links ignored due to external: 123187
number of links ignored due to exceptions: 24
number of intra doc links ignored: 9
errors found: 2
found some broken links
NOTE: if you are adding or renaming a markdown file in a mdBook, don't forget to register the page in SUMMARY.md
Bootstrap failed while executing `--stage 2 test --skip tests --skip coverage-map --skip coverage-run --skip library --skip tidyselftest`
Command `/checkout/obj/build/aarch64-unknown-linux-gnu/stage1-tools-bin/linkchecker /checkout/obj/build/aarch64-unknown-linux-gnu/doc` failed with exit code 1
Created at: src/bootstrap/src/core/build_steps/tool.rs:1612:23
Executed at: src/bootstrap/src/core/build_steps/test.rs:190:77

Command has failed. Rerun with -v to see more details.
Build completed unsuccessfully in 0:37:51
  local time: Tue Dec 16 14:52:36 UTC 2025
  network time: Tue, 16 Dec 2025 14:52:36 GMT
##[error]Process completed with exit code 1.
##[group]Run echo "disk usage:"

@fmease fmease added the F-doc_cfg `#![feature(doc_cfg)]` label Dec 16, 2025
@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Dec 16, 2025 •
edited
Loading

That's extremely annoying that we cannot update cargo files directly in here. Sending a PR to their repository then...

EDIT: cargo PR is here: rust-lang/cargo#16404

@fmease
Copy link
Member

fmease commented Dec 16, 2025

There are still 14 open issues (w/o the tracking issue) (via). Some of these may be blocking (in the sense that it would be much easier to address them now that the feature isn't stable yet than later when we're a lot more restricted in what we can do).

For example, I'm relatively certain that #147033 should be taken as blocking unless it's a breaking change anyway, need to read up on it again.

@GuillaumeGomez GuillaumeGomez mentioned this pull request Dec 16, 2025
Open
@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Dec 16, 2025

Oof, yeah indeed. Can you list them all in the tracking issue then please? Definitely sounds like blockers. Marking this PR as blocked in the meantime.

@GuillaumeGomez GuillaumeGomez added the S-blocked Status: Blocked on something else such as an RFC or other implementation work. label Dec 16, 2025
@fmease
Copy link
Member

fmease commented Dec 16, 2025 •
edited
Loading

Moreover, the tracking issue lists two medium-large unresolved questions. I'm not expecting a full stabilization report but it would be nice to list & consider everything that blocks the stabilization (that's the whole purpose of that list, isn't it?) in the PR description plus other concerns & risks. ;'D

@fmease fmease added the needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. label Dec 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@notriddle notriddle

Labels

F-doc_cfg `#![feature(doc_cfg)]` needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. S-blocked Status: Blocked on something else such as an RFC or other implementation work. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

rustdoc: Tracking issue for #[doc(cfg)] and automatically documented #[cfg]s

5 participants

@GuillaumeGomez @rustbot @rust-log-analyzer @fmease @notriddle