Skip to content

[rustdoc] Do not take doc(cfg()) into account when filtering doctests - #159014

Open
GuillaumeGomez wants to merge 5 commits into
rust-lang:mainfrom
GuillaumeGomez:doc-cfg-filter-doctest
Open

[rustdoc] Do not take doc(cfg()) into account when filtering doctests#159014
GuillaumeGomez wants to merge 5 commits into
rust-lang:mainfrom
GuillaumeGomez:doc-cfg-filter-doctest

Conversation

@GuillaumeGomez

@GuillaumeGomez GuillaumeGomez commented Jul 9, 2026 •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

View all comments

Part of #147033.

Because it was using the extract_cfg_from_attrs common function, it was taking into account the doc(cfg()) attributes the same as if they were a cfg.

I didn't mark this PR as "fix" because I didn't handle the case of the doctest not being marked as ignored because I'm not sure if we should revisit the fact that we ignore these doctests or if we should just mark them as ignored (because of target_feature(enable = "...")).

Setting @fmease as reviewer as they are likely the only one with context about this issue. 😆

r? @fmease

@rustbot rustbot added A-run-make Area: port run-make Makefiles to rmake.rs 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-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 9, 2026
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez

GuillaumeGomez commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

And now it fails because we (doc) inlined some functions. Fixing that then. :)

@rustbot rustbot added O-wasi Operating system: Wasi, Webassembly System Interface O-wasm Target: WASM (WebAssembly), http://webassembly.org/ O-windows Operating system: Windows labels Jul 9, 2026
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomez force-pushed the doc-cfg-filter-doctest branch from f5059c8 to 062cfea Compare July 9, 2026 14:58
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomez force-pushed the doc-cfg-filter-doctest branch from 062cfea to 1d5692c Compare July 9, 2026 15:43
@GuillaumeGomez

GuillaumeGomez commented Jul 9, 2026

Copy link
Copy Markdown
Member Author

Fixed CI \o/

fmease
fmease reviewed Jul 14, 2026
View reviewed changes
Comment thread src/librustdoc/clean/cfg.rs
@GuillaumeGomez
GuillaumeGomez force-pushed the doc-cfg-filter-doctest branch from 1d5692c to a0bf3c9 Compare July 15, 2026 13:10
@rustbot

This comment has been minimized.

Sign in to view
@GuillaumeGomez

GuillaumeGomez commented Jul 15, 2026

Copy link
Copy Markdown
Member Author

Reverted changes I made to extract_cfg_from_attrs and instead only look for the target_feature attributes.

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez

GuillaumeGomez commented Jul 15, 2026

Copy link
Copy Markdown
Member Author

Ah, new stuff gets added.

@GuillaumeGomez
GuillaumeGomez force-pushed the doc-cfg-filter-doctest branch from a0bf3c9 to 59a72c3 Compare July 15, 2026 14:50
@rustbot

rustbot commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

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

cc @Amanieu, @folkertdev, @sayantn

@GuillaumeGomez
GuillaumeGomez force-pushed the doc-cfg-filter-doctest branch from 59a72c3 to 885af7e Compare July 15, 2026 15:53
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomez force-pushed the doc-cfg-filter-doctest branch from 885af7e to 21e8051 Compare July 15, 2026 20:35
@GuillaumeGomez

GuillaumeGomez commented Jul 16, 2026

Copy link
Copy Markdown
Member Author

Seems like CI is happy now.

@GuillaumeGomez

GuillaumeGomez commented Jul 24, 2026

Copy link
Copy Markdown
Member Author

Setting a new reviewer as fmease seems busy.

r? @Urgau

@rustbot rustbot assigned Urgau and unassigned fmease Jul 24, 2026
@JonathanBrouwer JonathanBrouwer mentioned this pull request Aug 3, 2026
Closed
rust-bors Bot pushed a commit that referenced this pull request Aug 3, 2026
@bors
Auto merge of #160437 - JonathanBrouwer:rollup-03lFkkZ, r=JonathanBro…
b6b6abb 
…uwer

Rollup of 21 pull requests

Successful merges:

 - #159844 (Subtree cg_gcc sync (2026-07-24))
 - #159326 (Deny multiple EII impls on a single item)
 - #159535 (Optimize slice::contains for bytewise types)
 - #159595 (Promote loongarch32-unknown-none* to Tier 2)
 - #160007 (allow `-Ldependency` search paths for panic runtimes)
 - #160320 (point at trait definition when it is used as a derive macro)
 - #160369 (When suggesting method names, prefer *exact* doc aliases over similar names)
 - #160406 (`DepKind` cleanups)
 - #160424 (Use `thread::available_parallelism` as the default limit for backend parallelism)
 - #159014 ([rustdoc] Do not take `doc(cfg())` into account when filtering doctests)
 - #159303 (Fix ICE for direct inline const generic defaults)
 - #159977 (Add regression test for bool indexing codegen)
 - #160165 (reject `...` without pattern post-expansion)
 - #160295 (Fix rustdoc ICE when checking if a generic arg can be elided)
 - #160305 (Linkify C-SKY targets in `platform-support.md`)
 - #160314 (fix borrowck ICE for consts with fn pointer type)
 - #160322 (ElaborateBoxDeref: remove unnecessary projection)
 - #160338 (Add regression test for supertrait associated type normalization through dyn)
 - #160340 (Add regression test for unused_parens on contract clauses)
 - #160371 (Add doc aliases for transpositions `read_exact_buf` and `read_exact_buf_at`)
 - #160384 (Add PR body notes for Cargo lock file maintenance)
@JonathanBrouwer

JonathanBrouwer commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

💔 I suspect this PR failed tests as part of a rollup
@bors r-

After fixing the problem, consider running a try job for the failed job before re-approving.

Link to failure: #160437 (comment)

Probably caused by this PR?
@bors try jobs=x86_64-msvc-1

@rust-bors rust-bors Bot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Aug 3, 2026
@rust-bors

rust-bors Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

This pull request was unapproved.

View changes since this unapproval

@rust-bors

This comment has been minimized.

Sign in to view
rust-bors Bot pushed a commit that referenced this pull request Aug 3, 2026
@bors
Auto merge of #159014 - GuillaumeGomez:doc-cfg-filter-doctest, r=<try>
e0c307b 
[rustdoc] Do not take `doc(cfg())` into account when filtering doctests


try-job: x86_64-msvc-1
@rust-bors

rust-bors Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

💔 Test for e0c307b failed: CI. Failed job:

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez

GuillaumeGomez commented Aug 3, 2026

Copy link
Copy Markdown
Member Author

Let's try again.

@bors try jobs=x86_64-msvc-1,pr-check-2

@rust-bors

This comment has been minimized.

Sign in to view
rust-bors Bot pushed a commit that referenced this pull request Aug 3, 2026
@bors
Auto merge of #159014 - GuillaumeGomez:doc-cfg-filter-doctest, r=<try>
65b2394 
[rustdoc] Do not take `doc(cfg())` into account when filtering doctests


try-job: x86_64-msvc-1
try-job: pr-check-2
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomez force-pushed the doc-cfg-filter-doctest branch from c154b1e to c3f66e2 Compare August 3, 2026 22:24
@rustbot rustbot added O-hermit Operating System: Hermit O-linux Operating system: Linux O-netbsd Operating system: NetBSD O-redox Operating system: Redox, https://www.redox-os.org/ O-SGX Target: SGX O-solid Operating System: SOLID O-unix Operating system: Unix-like labels Aug 3, 2026
@GuillaumeGomez

GuillaumeGomez commented Aug 3, 2026

Copy link
Copy Markdown
Member Author

@bors try jobs=x86_64-msvc-1,pr-check-2

@rust-bors

This comment has been minimized.

Sign in to view
rust-bors Bot pushed a commit that referenced this pull request Aug 3, 2026
@bors
Auto merge of #159014 - GuillaumeGomez:doc-cfg-filter-doctest, r=<try>
38cc34c 
[rustdoc] Do not take `doc(cfg())` into account when filtering doctests


try-job: x86_64-msvc-1
try-job: pr-check-2
@rust-log-analyzer

rust-log-analyzer commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

The job pr-check-2 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot) 
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - arch (line 282) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - core_arch::arch (line 246) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - core_arch::arch (line 59) ... ignored
test library/core/src/../../stdarch/crates/core_arch/src/mod.rs - core_arch::arch::wasm32 (line 158) ... ignored
test library/core/src/../../stdarch/crates/core_arch/src/nvptx/mod.rs - core_arch::nvptx::vprintf (line 160) ... ignored
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - core_arch::arch (line 282) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/x86/mod.rs - core_arch::x86::__m128 (line 89) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/x86/mod.rs - core_arch::x86::__m128d (line 136) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/x86/mod.rs - core_arch::x86::__m128i (line 42) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/x86/sse.rs - core_arch::x86::sse::_mm_setcsr (line 1580) ... ignored

@rust-log-analyzer

rust-log-analyzer commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

The job pr-check-2 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot) 
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - core_arch::arch (line 115) ... ignored
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - core_arch::arch (line 246) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - core_arch::arch (line 59) ... ignored
test library/core/src/../../stdarch/crates/core_arch/src/mod.rs - core_arch::arch::wasm32 (line 158) ... ignored
test library/core/src/../../stdarch/crates/core_arch/src/nvptx/mod.rs - core_arch::nvptx::vprintf (line 160) ... ignored
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - arch (line 282) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - arch (line 246) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/core_arch_docs.md - core_arch::arch (line 282) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/x86/mod.rs - core_arch::x86::__m128 (line 89) ... ok
test library/core/src/../../stdarch/crates/core_arch/src/x86/mod.rs - core_arch::x86::__m128d (line 136) ... ok

@rust-bors

rust-bors Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

💔 Test for 38cc34c failed: CI. Failed job:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fmease fmease fmease left review comments
@Urgau Urgau Urgau approved these changes

Assignees

@Urgau Urgau

Labels

A-run-make Area: port run-make Makefiles to rmake.rs O-hermit Operating System: Hermit O-linux Operating system: Linux O-netbsd Operating system: NetBSD O-redox Operating system: Redox, https://www.redox-os.org/ O-SGX Target: SGX O-solid Operating System: SOLID O-unix Operating system: Unix-like O-wasi Operating system: Wasi, Webassembly System Interface O-wasm Target: WASM (WebAssembly), http://webassembly.org/ O-windows Operating system: Windows S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-compiler Relevant to the compiler 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.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@GuillaumeGomez @rust-log-analyzer @rustbot @Urgau @jhpratt @JonathanBrouwer @fmease