Skip to content

Document #[cfg(version(...))] #1828

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

est31
Copy link
Member

@est31 est31 commented May 17, 2025

Document #[cfg(version(...))] as it is to be stabilized.

Tracking issue: rust-lang/rust#64796
RFC: rust-lang/rfcs#2523
Stabilization PR: rust-lang/rust#141137
Earlier documentation PR filed for the first attempt: #981

@rustbot rustbot added the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label May 17, 2025
Comment on lines 58 to 71
r[cfg.predicate.version]
* `version()` with a version number inside. It is true if the language version
the compiler targets is higher or equal to the contained version number.
It is false otherwise.

This comment was marked as resolved.

@ehuss ehuss added the S-waiting-on-stabilization Waiting for a stabilization PR to be merged in the main Rust repository label May 17, 2025
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

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

Can you make sure to not wrap lines when adding new content?

Comment on lines 307 to 308
r[cfg.version]
## The `version()` predicate
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems a little confusing to have both this and cfg.predicate.version. I'm wondering if it would make sense to extend the "option" grammar to include version(...), and just remove cfg.predicate.version? Then version() would just be another option shown in the list here.

And the section header should probably be third level, and match the style of the other options.

Suggested change
r[cfg.version]
## The `version()` predicate
r[cfg.version]
### `version()`

Comment on lines 315 to 317
of the language the compiler targets. Usually the compiler version and
language version match. So compiler version `1.50.0` targets language
`1.50.0`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Usually the reference focuses on the language and not specifics about the compiler or specific implementations. The text here seems a little confusing in that regard. I would probably just strike this content.

Suggested change
of the language the compiler targets. Usually the compiler version and
language version match. So compiler version `1.50.0` targets language
`1.50.0`.
of the language the compiler targets.

Copy link
Contributor

@madsmtm madsmtm May 19, 2025

Choose a reason for hiding this comment

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

Though it might be beneficial to discuss a bit how this would work in alternative implementations like mrustc / gccrs? Though maybe "the language the compiler targets" is enough for that, unsure how I'd state it differently.


r[cfg.version.format]
In order for it to be considered of valid format, the version number has to
follow either the `"a.b.c"` scheme or the `"a.b"` scheme, where `a,b,c` are
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
follow either the `"a.b.c"` scheme or the `"a.b"` scheme, where `a,b,c` are
follow either the `"a.b.c"` scheme or the `"a.b"` scheme, where `a`, `b`, and `c` are

r[cfg.version.format]
In order for it to be considered of valid format, the version number has to
follow either the `"a.b.c"` scheme or the `"a.b"` scheme, where `a,b,c` are
decimal integers between `0` and `65535`, inclusively. Semantically, assume `c`
Copy link
Contributor

Choose a reason for hiding this comment

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

Question: Does this detail matter in the reference? Isn't it enough to say "these should be integers", and leave the range to the compiler implementation?

Copy link
Contributor

Choose a reason for hiding this comment

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

@traviscross and I discussed this a little bit and felt like this probably should be specified? For example, if you say cfg(version("1.81.65535")), that will be true, but cfg(version("1.81.65536")) will be false. Since the magnitude of what gets parsed seems to matter, it might be good to be clear about that.

This is a bit extreme, though. Even if an implementation used u8, it's still 19 years before 1.256 (assuming we stick with 6 week releases), and seems silly for someone to put an unnecessarily large number there.

Copy link
Member Author

Choose a reason for hiding this comment

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

hmm yeah good point. For future compatibility we will warn on unknown version literal formats, which includes 1.81.65536. We should probably word it in a way that the unknown formats are not guaranteed to evaluate to false.

@est31 est31 requested review from ehuss and traviscross May 26, 2025 22:31
@est31 est31 force-pushed the cfg_version branch 2 times, most recently from a3cfd48 to c94399f Compare May 26, 2025 23:21
@@ -23,6 +24,15 @@ ConfigurationAny ->
ConfigurationNot ->
`not` `(` ConfigurationPredicate `)`
ConfigurationVersion ->
`version` `(` `"` ConfigurationVersionLiteral `"` `)`
Copy link
Contributor

@ehuss ehuss May 28, 2025

Choose a reason for hiding this comment

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

Shouldn't this be:

Suggested change
`version` `(` `"` ConfigurationVersionLiteral `"` `)`
`version` `(` ( STRING_LITERAL | RAW_STRING_LITERAL ) `)`

and assuming it is, I would just delete the other grammar productions and describe the format of the string in cfg.predicate.version in plain English. Or, we can keep ConfigurationVersionLiteral if you want, but the text will still need to be updated to say that the string needs to conform to the format described by ConfigurationVersionLiteral.

Copy link
Member Author

@est31 est31 May 29, 2025

Choose a reason for hiding this comment

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

yeah I think STRING_LITERAL | RAW_STRING_LITERAL is fine.

This works

#[cfg(version(r"1.0"))] fn foo() {}

foo();

note that syntactically, we don't require string literals here, i.e. this doesn't give an error:

#[cfg(any())]
#[cfg(version(hello(world)))] fn foo() {}

#[cfg(any())]
#[cfg(version(123))] fn foo() {}

probably the same for all cfg syntaxes.

Comment on lines +68 to +63
r[cfg.predicate.version]
* `version()` with a version number inside. It is true if the language version
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we merge cfg.version into this section so that it isn't described in two places?

r[cfg.version.format]
In order for it to be considered of valid format, the version number has to
follow either the `"a.b.c"` scheme or the `"a.b"` scheme, where `a,b,c` are
decimal integers between `0` and `65535`, inclusively. Semantically, assume `c`
Copy link
Contributor

Choose a reason for hiding this comment

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

@traviscross and I discussed this a little bit and felt like this probably should be specified? For example, if you say cfg(version("1.81.65535")), that will be true, but cfg(version("1.81.65536")) will be false. Since the magnitude of what gets parsed seems to matter, it might be good to be clear about that.

This is a bit extreme, though. Even if an implementation used u8, it's still 19 years before 1.256 (assuming we stick with 6 week releases), and seems silly for someone to put an unnecessarily large number there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: The marked PR is awaiting review from a maintainer S-waiting-on-stabilization Waiting for a stabilization PR to be merged in the main Rust repository
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants