Store #[deprecated] attribute's `since` value in parsed form #117377

dtolnay · 2023-10-30T06:01:14Z

This PR implements the first followup bullet listed in #117148 (comment).

We centralize error handling to the attribute parsing code in compiler/rustc_attr/src/builtin.rs, and thereby remove some awkward error codepaths from later phases of compilation that had to make sense of these #[deprecated] attributes, namely compiler/rustc_passes/src/stability.rs and compiler/rustc_middle/src/middle/stability.rs.

rustbot · 2023-10-30T06:01:23Z

r? @b-naber

(rustbot has picked a reviewer for you, use r? to override)

dtolnay · 2023-10-30T06:06:59Z

compiler/rustc_middle/src/middle/stability.rs

-    };
-
-    // Assume deprecation is in effect if "since" field is missing
-    // or if we can't determine the current Rust version.


The "or if we can't determine the current Rust version" part of this comment should have been removed by #117256.

cjgillot · 2023-10-30T11:31:37Z

compiler/rustc_attr/src/builtin.rs

+                Some(DeprecatedSince::RustcVersion(version))
+            } else {
+                sess.emit_err(session_diagnostics::InvalidSince { span: attr.span });
+                Some(DeprecatedSince::Symbol(since))


I'm not convinced that reusing this variant for both purposes is useful. What about an Err variant?

👍 I have added DeprecatedSince::Err for this case

cjgillot · 2023-10-30T11:32:24Z

compiler/rustc_attr/src/builtin.rs

            }
+        } else if is_rustc {
+            sess.emit_err(session_diagnostics::MissingSince { span: attr.span });
+            continue;


Should we stop discarding the attribute on missing since?

Yes, good catch. Fixed.

I chose to use DeprecatedSince::Err here instead of DeprecatedSince::Unspecified. I used Unspecified for the non-feature(staged_api) case where deprecation versions are optional, and DeprecatedSince::Err for the feature(staged_api) case where deprecation versions are mandatory and must be parsed as a valid version; whether missing or invalid, you get DeprecatedSince::Err, and it tells downstream code that it can rely on an error already having been emitted. Let me know what you think.

cjgillot · 2023-10-30T11:33:27Z

compiler/rustc_middle/src/middle/stability.rs

@@ -126,36 +128,14 @@ pub fn report_unstable(
 /// Checks whether an item marked with `deprecated(since="X")` is currently
 /// deprecated (i.e., whether X is not greater than the current rustc version).
 pub fn deprecation_in_effect(depr: &Deprecation) -> bool {


Can this be made an inherent method on Deprecation or DeprecatedSince?

Done; added pub fn is_in_effect(&self) -> bool on Deprecation.

cjgillot · 2023-10-30T11:34:20Z

compiler/rustc_attr/src/builtin.rs

+    /// already been emitted. In the former case, deprecation versions outside
+    /// the standard library are allowed to be arbitrary strings, for better or
+    /// worse.
+    Symbol(Symbol),


This variant name is not very descriptive? Custom ? UserDefined ?

Do you like NonStandard? It indicates both that this is used outside the standard library and also that it can contain an arbitrary string.

cjgillot · 2023-10-30T11:35:02Z

compiler/rustc_middle/src/middle/stability.rs

@@ -381,7 +359,7 @@ impl<'tcx> TyCtxt<'tcx> {
                // With #![staged_api], we want to emit down the whole
                // hierarchy.
                let depr_attr = &depr_entry.attr;
-                if !skip || depr_attr.is_since_rustc_version {
+                if !skip || matches!(depr_attr.since, Some(DeprecatedSince::RustcVersion(_))) {


Do we need a is_since_rustc_version method?

It's okay either way, I think. Here is what having a method looks like: 8b8906b.

It's not that widely useful because most places that look for DeprecatedSince::RustcVersion(version) also want to do something with the version. I found 2 places that didn't (the ones in that commit link). We could do fn get_since_rustc_version(&self) -> Option<RustcVersion> which is more broadly applicable, and then instead of .is_since_rustc_version() do .get_since_rustc_version().is_some(), but at that point it's no longer better than pattern matching the usual ways.

cjgillot · 2023-10-30T11:36:09Z

compiler/rustc_attr/src/builtin.rs

@@ -720,17 +721,37 @@ pub fn eval_condition(

 #[derive(Copy, Debug, Encodable, Decodable, Clone, HashStable_Generic)]
 pub struct Deprecation {
-    pub since: Option<Symbol>,
+    pub since: Option<DeprecatedSince>,


Should we add a Missing variant and remove the Option?

Missing would make some things more complicated because then it no longer makes sense for DeprecatedSince to implement Display, which rustdoc currently relies on.

Rustdoc may already need a different approach upon introducing an Err variant so I'll take a look.

After introducing Err, eliminating the Option indeed seems like the right call. 👍

…brary

rustbot · 2023-10-31T00:13:52Z

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

Some changes occurred in src/librustdoc/clean/types.rs

cc @camelid

cjgillot · 2023-10-31T10:41:14Z

Thanks!
@bors r+

bors · 2023-10-31T10:41:17Z

📌 Commit 8b8906b has been approved by cjgillot

It is now in the queue for this repository.

bors · 2023-10-31T10:42:26Z

⌛ Testing commit 8b8906b with merge 22b2712...

bors · 2023-10-31T12:53:59Z

☀️ Test successful - checks-actions
Approved by: cjgillot
Pushing 22b2712 to master...

rust-timer · 2023-10-31T14:14:48Z

Finished benchmarking commit (22b2712): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-1.7%	[-2.0%, -1.4%]	2
All ❌✅ (primary)	-	-	0

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-2.7%	[-4.2%, -1.7%]	15
All ❌✅ (primary)	-	-	0

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 633.93s -> 636.003s (0.33%)
Artifact size: 304.43 MiB -> 304.48 MiB (0.01%)

dtolnay added 4 commits October 29, 2023 21:39

Rename Since -> StableSince in preparation for a DeprecatedSince

1e5b2da

Fill in syntactically valid deprecation version in tests

5c7cf83

Store version of deprecated attribute in structured form

2fe7d17

Delete unused InvalidDeprecationVersion diagnostic

8afb40b

rustbot assigned b-naber Oct 30, 2023

dtolnay mentioned this pull request Oct 30, 2023

Validate feature and since values inside #[stable(…)] #116773

Merged

dtolnay commented Oct 30, 2023

View reviewed changes

cjgillot reviewed Oct 30, 2023

View reviewed changes

dtolnay 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-review Status: Awaiting review from the assignee but also interested parties. labels Oct 30, 2023

dtolnay added 6 commits October 30, 2023 09:02

Move deprecation_in_effect to inherent method on Deprecation

1e10fe9

Add a DeprecatedSince::Err variant for versions that fail to parse

b106167

Preserve deprecation attribute even if 'since' version is missing

c523672

Represent absence of 'since' attribute as a variant of DeprecatedSince

e8868af

Descriptive variant name deprecation versions outside the standard li…

dccf10e

…brary

Add method for checking if deprecation is a rustc version

8b8906b

dtolnay added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 31, 2023

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 Oct 31, 2023

bors added the merged-by-bors This PR was explicitly merged by bors. label Oct 31, 2023

bors merged commit 22b2712 into rust-lang:master Oct 31, 2023
12 checks passed

rustbot added this to the 1.75.0 milestone Oct 31, 2023

dtolnay deleted the deprecatedsince branch October 31, 2023 13:16

github-actions bot mentioned this pull request Nov 1, 2023

Automated pull from upstream master ferrocene/ferrocene#78

Merged

DJMcNab mentioned this pull request Sep 25, 2024

Allow deprecated_in_future lint to specify an indeterminate future deprecation date #78381

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Store #[deprecated] attribute's `since` value in parsed form #117377

Store #[deprecated] attribute's `since` value in parsed form #117377

dtolnay commented Oct 30, 2023

rustbot commented Oct 30, 2023

dtolnay Oct 30, 2023

cjgillot Oct 30, 2023 •

edited

Loading

dtolnay Oct 31, 2023

cjgillot Oct 30, 2023

dtolnay Oct 31, 2023

cjgillot Oct 30, 2023

dtolnay Oct 31, 2023

cjgillot Oct 30, 2023

dtolnay Oct 30, 2023

cjgillot Oct 30, 2023

dtolnay Oct 31, 2023

cjgillot Oct 30, 2023

dtolnay Oct 30, 2023

dtolnay Oct 31, 2023

rustbot commented Oct 31, 2023

cjgillot commented Oct 31, 2023

bors commented Oct 31, 2023

bors commented Oct 31, 2023

bors commented Oct 31, 2023

rust-timer commented Oct 31, 2023

Store #[deprecated] attribute's since value in parsed form #117377

Store #[deprecated] attribute's since value in parsed form #117377

Conversation

dtolnay commented Oct 30, 2023

rustbot commented Oct 30, 2023

Choose a reason for hiding this comment

cjgillot Oct 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustbot commented Oct 31, 2023

cjgillot commented Oct 31, 2023

bors commented Oct 31, 2023

bors commented Oct 31, 2023

bors commented Oct 31, 2023

rust-timer commented Oct 31, 2023

Overall result: no relevant changes - no action needed

Store #[deprecated] attribute's `since` value in parsed form #117377

Store #[deprecated] attribute's `since` value in parsed form #117377

cjgillot Oct 30, 2023 •

edited

Loading