Skip to content

update cfg_select! documentation #143941

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
Merged
merged 1 commit into from
Jul 15, 2025
Merged

update cfg_select! documentation #143941

merged 1 commit into from
Jul 15, 2025

Conversation

folkertdev
Copy link
Contributor

@folkertdev folkertdev commented Jul 14, 2025 •
edited by rustbot
Loading

tracking issue: #115585

After #143461, and with an eye on a soon(ish) stabilization, I think the docs need some work.

The existing text read more like a motivation for the feature existing to me, so I've tried to now be a bit more descriptive. Still, suggestions are very welcome.

I also added a test for an empty select! {} because it's just the sort of thing that might break.

r? @traviscross

@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. labels Jul 14, 2025
traviscross
traviscross reviewed Jul 14, 2025
View reviewed changes
tests/ui/macros/cfg_select.rs Outdated
@@ -25,3 +25,6 @@ cfg_select! {
//~^ ERROR none of the rules in this `cfg_select` evaluated to true
false => {}
}

cfg_select! {}
//~^ ERROR none of the rules in this `cfg_select` evaluated to true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not necessarily a matter for this PR, but we should probably update this to refer to predicates rather than rules.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's easier to just have the terminology be consistent, so I replaced "rule" with "predicate" everywhere.

@folkertdev @traviscross
update cfg_select! documentation
d0153f5 
and make internal terminology consistent

Co-authored-by: Travis Cross <[email protected]>
@traviscross
Copy link
Contributor

Thanks @folkertdev for making this update.

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jul 14, 2025

📌 Commit d0153f5 has been approved by traviscross

It is now in the queue for this repository.

@bors 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 Jul 14, 2025
@traviscross traviscross added the T-lang Relevant to the language team label Jul 14, 2025
jhpratt added a commit to jhpratt/rust that referenced this pull request Jul 15, 2025
@jhpratt
Rollup merge of rust-lang#143941 - folkertdev:cfg-select-docs, r=trav…
e52a780 
…iscross

update `cfg_select!` documentation

tracking issue: rust-lang#115585

After rust-lang#143461, and with an eye on a soon(ish) stabilization, I think the docs need some work.

The existing text read more like a motivation for the feature existing to me, so I've tried to now be a bit more descriptive. Still, suggestions are very welcome.

I also added a test for an empty `select! {}` because it's just the sort of thing that might break.

r? `@traviscross`
@jhpratt jhpratt mentioned this pull request Jul 15, 2025
Closed
bors added a commit that referenced this pull request Jul 15, 2025
@bors
Auto merge of #143951 - jhpratt:rollup-vqxstga, r=jhpratt
86fdc82 
Rollup of 16 pull requests

Successful merges:

 - #142301 (tests: Fix duplicated-path-in-error fail with musl)
 - #142936 (rustdoc-json: Structured attributes)
 - #143355 (wrapping shift: remove first bitmask and table)
 - #143630 (Drop `./x suggest`)
 - #143738 (Move several float tests to floats/mod.rs)
 - #143752 (Don't panic if WASI_SDK_PATH not set when detecting compiler)
 - #143820 (Fixed a core crate compilation failure when enabling the `optimize_for_size` feature on some targets)
 - #143837 (Adjust `run_make_support::symbols` helpers)
 - #143878 (Port `#[pointee]` to the new attribute parsing infrastructure)
 - #143907 (core: make `str::split_at_unchecked()` inline)
 - #143910 (Add experimental `backtrace-trace-only` std feature)
 - #143927 (Preserve constness in trait objects up to hir ty lowering)
 - #143935 (rustc_type_ir/walk: move docstring to `TypeWalker` itself)
 - #143938 (Update books)
 - #143941 (update `cfg_select!` documentation)
 - #143948 (Update mdbook to 0.4.52)

Failed merges:

 - #143926 (Remove deprecated fields in bootstrap)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit that referenced this pull request Jul 15, 2025
@bors
Auto merge of #143951 - jhpratt:rollup-vqxstga, r=jhpratt
bb61a29 
Rollup of 16 pull requests

Successful merges:

 - #142301 (tests: Fix duplicated-path-in-error fail with musl)
 - #142936 (rustdoc-json: Structured attributes)
 - #143355 (wrapping shift: remove first bitmask and table)
 - #143630 (Drop `./x suggest`)
 - #143738 (Move several float tests to floats/mod.rs)
 - #143752 (Don't panic if WASI_SDK_PATH not set when detecting compiler)
 - #143820 (Fixed a core crate compilation failure when enabling the `optimize_for_size` feature on some targets)
 - #143837 (Adjust `run_make_support::symbols` helpers)
 - #143878 (Port `#[pointee]` to the new attribute parsing infrastructure)
 - #143907 (core: make `str::split_at_unchecked()` inline)
 - #143910 (Add experimental `backtrace-trace-only` std feature)
 - #143927 (Preserve constness in trait objects up to hir ty lowering)
 - #143935 (rustc_type_ir/walk: move docstring to `TypeWalker` itself)
 - #143938 (Update books)
 - #143941 (update `cfg_select!` documentation)
 - #143948 (Update mdbook to 0.4.52)

Failed merges:

 - #143926 (Remove deprecated fields in bootstrap)

r? `@ghost`
`@rustbot` modify labels: rollup
@samueltardieu samueltardieu mentioned this pull request Jul 15, 2025
Merged
bors added a commit that referenced this pull request Jul 15, 2025
@bors
Auto merge of #143958 - samueltardieu:rollup-lh1s143, r=samueltardieu
e27f16a 
Rollup of 13 pull requests

Successful merges:

 - #142301 (tests: Fix duplicated-path-in-error fail with musl)
 - #143630 (Drop `./x suggest`)
 - #143736 (Give all bytes of TypeId provenance)
 - #143752 (Don't panic if WASI_SDK_PATH not set when detecting compiler)
 - #143837 (Adjust `run_make_support::symbols` helpers)
 - #143878 (Port `#[pointee]` to the new attribute parsing infrastructure)
 - #143905 (Recover and suggest to use `;` to construct array type)
 - #143907 (core: make `str::split_at_unchecked()` inline)
 - #143910 (Add experimental `backtrace-trace-only` std feature)
 - #143927 (Preserve constness in trait objects up to hir ty lowering)
 - #143935 (rustc_type_ir/walk: move docstring to `TypeWalker` itself)
 - #143938 (Update books)
 - #143941 (update `cfg_select!` documentation)

Failed merges:

 - #143926 (Remove deprecated fields in bootstrap)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 010e3ef into rust-lang:master Jul 15, 2025
11 checks passed
rust-timer added a commit that referenced this pull request Jul 15, 2025
@rust-timer
Unrolled build for #143941
f4ad096 
Rollup merge of #143941 - folkertdev:cfg-select-docs, r=traviscross

update `cfg_select!` documentation

tracking issue: #115585

After #143461, and with an eye on a soon(ish) stabilization, I think the docs need some work.

The existing text read more like a motivation for the feature existing to me, so I've tried to now be a bit more descriptive. Still, suggestions are very welcome.

I also added a test for an empty `select! {}` because it's just the sort of thing that might break.

r? ``@traviscross``
@rustbot rustbot added this to the 1.90.0 milestone Jul 15, 2025
github-actions bot pushed a commit to rust-lang/rustc-dev-guide that referenced this pull request Jul 17, 2025
@bors
Auto merge of #143958 - samueltardieu:rollup-lh1s143, r=samueltardieu
42a3530 
Rollup of 13 pull requests

Successful merges:

 - rust-lang/rust#142301 (tests: Fix duplicated-path-in-error fail with musl)
 - rust-lang/rust#143630 (Drop `./x suggest`)
 - rust-lang/rust#143736 (Give all bytes of TypeId provenance)
 - rust-lang/rust#143752 (Don't panic if WASI_SDK_PATH not set when detecting compiler)
 - rust-lang/rust#143837 (Adjust `run_make_support::symbols` helpers)
 - rust-lang/rust#143878 (Port `#[pointee]` to the new attribute parsing infrastructure)
 - rust-lang/rust#143905 (Recover and suggest to use `;` to construct array type)
 - rust-lang/rust#143907 (core: make `str::split_at_unchecked()` inline)
 - rust-lang/rust#143910 (Add experimental `backtrace-trace-only` std feature)
 - rust-lang/rust#143927 (Preserve constness in trait objects up to hir ty lowering)
 - rust-lang/rust#143935 (rustc_type_ir/walk: move docstring to `TypeWalker` itself)
 - rust-lang/rust#143938 (Update books)
 - rust-lang/rust#143941 (update `cfg_select!` documentation)

Failed merges:

 - rust-lang/rust#143926 (Remove deprecated fields in bootstrap)

r? `@ghost`
`@rustbot` modify labels: rollup
Muscraft pushed a commit to Muscraft/rust that referenced this pull request Jul 21, 2025
@samueltardieu @Muscraft
Rollup merge of rust-lang#143941 - folkertdev:cfg-select-docs, r=trav…
d142505 
…iscross

update `cfg_select!` documentation

tracking issue: rust-lang#115585

After rust-lang#143461, and with an eye on a soon(ish) stabilization, I think the docs need some work.

The existing text read more like a motivation for the feature existing to me, so I've tried to now be a bit more descriptive. Still, suggestions are very welcome.

I also added a test for an empty `select! {}` because it's just the sort of thing that might break.

r? ``@traviscross``
Muscraft pushed a commit to Muscraft/rust that referenced this pull request Jul 21, 2025
@bors @Muscraft
Auto merge of rust-lang#143958 - samueltardieu:rollup-lh1s143, r=samu…
c5543be 
…eltardieu

Rollup of 13 pull requests

Successful merges:

 - rust-lang#142301 (tests: Fix duplicated-path-in-error fail with musl)
 - rust-lang#143630 (Drop `./x suggest`)
 - rust-lang#143736 (Give all bytes of TypeId provenance)
 - rust-lang#143752 (Don't panic if WASI_SDK_PATH not set when detecting compiler)
 - rust-lang#143837 (Adjust `run_make_support::symbols` helpers)
 - rust-lang#143878 (Port `#[pointee]` to the new attribute parsing infrastructure)
 - rust-lang#143905 (Recover and suggest to use `;` to construct array type)
 - rust-lang#143907 (core: make `str::split_at_unchecked()` inline)
 - rust-lang#143910 (Add experimental `backtrace-trace-only` std feature)
 - rust-lang#143927 (Preserve constness in trait objects up to hir ty lowering)
 - rust-lang#143935 (rustc_type_ir/walk: move docstring to `TypeWalker` itself)
 - rust-lang#143938 (Update books)
 - rust-lang#143941 (update `cfg_select!` documentation)

Failed merges:

 - rust-lang#143926 (Remove deprecated fields in bootstrap)

r? `@ghost`
`@rustbot` modify labels: rollup
github-actions bot pushed a commit to model-checking/verify-rust-std that referenced this pull request Jul 29, 2025
@samueltardieu
Rollup merge of rust-lang#143941 - folkertdev:cfg-select-docs, r=trav…
c9dbde9 
…iscross

update `cfg_select!` documentation

tracking issue: rust-lang#115585

After rust-lang#143461, and with an eye on a soon(ish) stabilization, I think the docs need some work.

The existing text read more like a motivation for the feature existing to me, so I've tried to now be a bit more descriptive. Still, suggestions are very welcome.

I also added a test for an empty `select! {}` because it's just the sort of thing that might break.

r? ``@traviscross``
@jieyouxu jieyouxu added the F-cfg_select `#![feature(cfg_select)]` label Aug 14, 2025
@jieyouxu jieyouxu mentioned this pull request Aug 14, 2025
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@traviscross traviscross traviscross left review comments

Assignees

@traviscross traviscross

Labels
F-cfg_select `#![feature(cfg_select)]` S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-lang Relevant to the language team T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.90.0
Development

Successfully merging this pull request may close these issues.
5 participants
@folkertdev @traviscross @bors @jieyouxu @rustbot