Change rustc_deprecated to use note

This keeps `reason` around for the time being. This is necessary to avoid breakage during the bootstrap process. This change, as a whole, brings `#[rustc_deprecated]` more in line with `#[deprecated]`.
rust-lang · Mar 4, 2022 · 6efc8e3 · 6efc8e3
1 parent 9fcbc32
commit 6efc8e3
Show file tree

Hide file tree

Showing 22 changed files with 146 additions and 143 deletions.
diff --git a/compiler/rustc_ast_passes/src/feature_gate.rs b/compiler/rustc_ast_passes/src/feature_gate.rs
@@ -438,6 +438,7 @@ impl<'a> Visitor<'a> for PostExpansionVisitor<'a> {
                 .emit();
             }
         } else {
+            // FIXME(jhpratt) remove this after the two attributes are merged
             if attr.has_name(sym::deprecated) {
                 self.sess
                     .struct_span_err(attr.span, "`#[deprecated]` cannot be used in staged API")

diff --git a/compiler/rustc_attr/src/builtin.rs b/compiler/rustc_attr/src/builtin.rs
@@ -729,11 +729,13 @@ where
                                     continue 'outer;
                                 }
                             }
-                            sym::note if attr.has_name(sym::deprecated) => {
+                            sym::note => {
                                 if !get(mi, &mut note) {
                                     continue 'outer;
                                 }
                             }
+                            // FIXME(jhpratt) remove this after a bootstrap occurs. Emitting an
+                            // error specific to the renaming would be a good idea as well.
                             sym::reason if attr.has_name(sym::rustc_deprecated) => {
                                 if !get(mi, &mut note) {
                                     continue 'outer;
@@ -753,7 +755,7 @@ where
                                         if attr.has_name(sym::deprecated) {
                                             &["since", "note"]
                                         } else {
-                                            &["since", "reason", "suggestion"]
+                                            &["since", "note", "suggestion"]
                                         },
                                     ),
                                 );
@@ -787,7 +789,7 @@ where
             }
 
             if note.is_none() {
-                struct_span_err!(diagnostic, attr.span, E0543, "missing 'reason'").emit();
+                struct_span_err!(diagnostic, attr.span, E0543, "missing 'note'").emit();
                 continue;
             }
         }

diff --git a/compiler/rustc_feature/src/builtin_attrs.rs b/compiler/rustc_feature/src/builtin_attrs.rs
@@ -461,7 +461,7 @@ pub const BUILTIN_ATTRIBUTES: &[BuiltinAttribute] = &[
     // DuplicatesOk since it has its own validation
     ungated!(
         rustc_deprecated, Normal,
-        template!(List: r#"since = "version", reason = "...""#), DuplicatesOk // See E0550
+        template!(List: r#"since = "version", note = "...""#), DuplicatesOk // See E0550
     ),
     // DuplicatesOk since it has its own validation
     ungated!(

diff --git a/src/test/ui/deprecation/rustc_deprecation-in-future.rs b/src/test/ui/deprecation/rustc_deprecation-in-future.rs
@@ -4,11 +4,11 @@
 
 #![stable(feature = "rustc_deprecation-in-future-test", since = "1.0.0")]
 
-#[rustc_deprecated(since = "99.99.99", reason = "effectively never")]
+#[rustc_deprecated(since = "99.99.99", note = "effectively never")]
 #[stable(feature = "rustc_deprecation-in-future-test", since = "1.0.0")]
 pub struct S1;
 
-#[rustc_deprecated(since = "TBD", reason = "literally never")]
+#[rustc_deprecated(since = "TBD", note = "literally never")]
 #[stable(feature = "rustc_deprecation-in-future-test", since = "1.0.0")]
 pub struct S2;
 

diff --git a/src/test/ui/issues/issue-17337.rs b/src/test/ui/issues/issue-17337.rs
@@ -7,7 +7,7 @@ struct Foo;
 
 impl Foo {
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     fn foo(self) {}
 }
 

diff --git a/src/test/ui/lint/auxiliary/inherited_stability.rs b/src/test/ui/lint/auxiliary/inherited_stability.rs
@@ -20,7 +20,7 @@ pub mod stable_mod {
 #[unstable(feature = "unstable_test_feature", issue = "none")]
 pub mod unstable_mod {
     #[stable(feature = "stable_test_feature", since = "1.0.0")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub fn deprecated() {}
 
     pub fn unstable() {}

diff --git a/src/test/ui/lint/auxiliary/lint_output_format.rs b/src/test/ui/lint/auxiliary/lint_output_format.rs
@@ -4,7 +4,7 @@
 #![unstable(feature = "unstable_test_feature", issue = "none")]
 
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub fn foo() -> usize {
     20
 }

diff --git a/src/test/ui/lint/auxiliary/lint_stability.rs b/src/test/ui/lint/auxiliary/lint_stability.rs
@@ -5,21 +5,21 @@
 #![stable(feature = "lint_stability", since = "1.0.0")]
 
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub fn deprecated() {}
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub fn deprecated_text() {}
 
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "99.99.99", reason = "text")]
+#[rustc_deprecated(since = "99.99.99", note = "text")]
 pub fn deprecated_future() {}
 
 #[unstable(feature = "unstable_test_feature", issue = "none")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub fn deprecated_unstable() {}
 #[unstable(feature = "unstable_test_feature", issue = "none")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub fn deprecated_unstable_text() {}
 
 #[unstable(feature = "unstable_test_feature", issue = "none")]
@@ -37,17 +37,17 @@ pub struct MethodTester;
 
 impl MethodTester {
     #[stable(feature = "stable_test_feature", since = "1.0.0")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub fn method_deprecated(&self) {}
     #[stable(feature = "stable_test_feature", since = "1.0.0")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub fn method_deprecated_text(&self) {}
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub fn method_deprecated_unstable(&self) {}
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub fn method_deprecated_unstable_text(&self) {}
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
@@ -64,17 +64,17 @@ impl MethodTester {
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
 pub trait Trait {
     #[stable(feature = "stable_test_feature", since = "1.0.0")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     fn trait_deprecated(&self) {}
     #[stable(feature = "stable_test_feature", since = "1.0.0")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     fn trait_deprecated_text(&self) {}
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     fn trait_deprecated_unstable(&self) {}
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     fn trait_deprecated_unstable_text(&self) {}
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
@@ -93,7 +93,7 @@ pub trait TraitWithAssociatedTypes {
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     type TypeUnstable = u8;
     #[stable(feature = "stable_test_feature", since = "1.0.0")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     type TypeDeprecated = u8;
 }
 
@@ -104,18 +104,18 @@ impl Trait for MethodTester {}
 pub trait UnstableTrait { fn dummy(&self) { } }
 
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub trait DeprecatedTrait {
     #[stable(feature = "stable_test_feature", since = "1.0.0")] fn dummy(&self) { }
 }
 
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct DeprecatedStruct {
     #[stable(feature = "stable_test_feature", since = "1.0.0")] pub i: isize
 }
 #[unstable(feature = "unstable_test_feature", issue = "none")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct DeprecatedUnstableStruct {
     #[stable(feature = "stable_test_feature", since = "1.0.0")] pub i: isize
 }
@@ -133,10 +133,10 @@ pub enum UnstableEnum {}
 pub enum StableEnum {}
 
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct DeprecatedUnitStruct;
 #[unstable(feature = "unstable_test_feature", issue = "none")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct DeprecatedUnstableUnitStruct;
 #[unstable(feature = "unstable_test_feature", issue = "none")]
 pub struct UnstableUnitStruct;
@@ -146,10 +146,10 @@ pub struct StableUnitStruct;
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
 pub enum Enum {
     #[stable(feature = "stable_test_feature", since = "1.0.0")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     DeprecatedVariant,
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     DeprecatedUnstableVariant,
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     UnstableVariant,
@@ -159,10 +159,10 @@ pub enum Enum {
 }
 
 #[stable(feature = "stable_test_feature", since = "1.0.0")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct DeprecatedTupleStruct(#[stable(feature = "rust1", since = "1.0.0")] pub isize);
 #[unstable(feature = "unstable_test_feature", issue = "none")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct DeprecatedUnstableTupleStruct(#[stable(feature = "rust1", since = "1.0.0")] pub isize);
 #[unstable(feature = "unstable_test_feature", issue = "none")]
 pub struct UnstableTupleStruct(#[stable(feature = "rust1", since = "1.0.0")] pub isize);

diff --git a/src/test/ui/lint/auxiliary/lint_stability_fields.rs b/src/test/ui/lint/auxiliary/lint_stability_fields.rs
@@ -6,7 +6,7 @@ pub struct Stable {
     pub inherit: u8,
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     pub override1: u8,
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     pub override2: u8,
     #[stable(feature = "rust2", since = "2.0.0")]
@@ -17,7 +17,7 @@ pub struct Stable {
 pub struct Stable2(#[stable(feature = "rust2", since = "2.0.0")] pub u8,
                    #[unstable(feature = "unstable_test_feature", issue = "none")] pub u8,
                    #[unstable(feature = "unstable_test_feature", issue = "none")]
-                   #[rustc_deprecated(since = "1.0.0", reason = "text")] pub u8,
+                   #[rustc_deprecated(since = "1.0.0", note = "text")] pub u8,
                    pub u8);
 
 #[stable(feature = "rust1", since = "1.0.0")]
@@ -28,7 +28,7 @@ pub enum Stable3 {
     Override1,
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     Override2,
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     Override3,
 }
@@ -38,7 +38,7 @@ pub struct Unstable {
     pub inherit: u8,
     #[stable(feature = "rust1", since = "1.0.0")]
     pub override1: u8,
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     pub override2: u8,
 }
@@ -47,10 +47,10 @@ pub struct Unstable {
 pub struct Unstable2(pub u8,
                      #[stable(feature = "rust1", since = "1.0.0")] pub u8,
                      #[unstable(feature = "unstable_test_feature", issue = "none")]
-                     #[rustc_deprecated(since = "1.0.0", reason = "text")] pub u8);
+                     #[rustc_deprecated(since = "1.0.0", note = "text")] pub u8);
 
 #[unstable(feature = "unstable_test_feature", issue = "none")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct Deprecated {
     pub inherit: u8,
     #[stable(feature = "rust1", since = "1.0.0")]
@@ -60,7 +60,7 @@ pub struct Deprecated {
 }
 
 #[unstable(feature = "unstable_test_feature", issue = "none")]
-#[rustc_deprecated(since = "1.0.0", reason = "text")]
+#[rustc_deprecated(since = "1.0.0", note = "text")]
 pub struct Deprecated2(pub u8,
                        #[stable(feature = "rust1", since = "1.0.0")] pub u8,
                        #[unstable(feature = "unstable_test_feature", issue = "none")] pub u8);
diff --git a/src/test/ui/lint/lint-stability-2.rs b/src/test/ui/lint/lint-stability-2.rs
@@ -169,10 +169,10 @@ mod cross_crate {
 
 mod this_crate {
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub fn deprecated() {}
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub fn deprecated_text() {}
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
@@ -190,10 +190,10 @@ mod this_crate {
 
     impl MethodTester {
         #[unstable(feature = "unstable_test_feature", issue = "none")]
-        #[rustc_deprecated(since = "1.0.0", reason = "text")]
+        #[rustc_deprecated(since = "1.0.0", note = "text")]
         pub fn method_deprecated(&self) {}
         #[unstable(feature = "unstable_test_feature", issue = "none")]
-        #[rustc_deprecated(since = "1.0.0", reason = "text")]
+        #[rustc_deprecated(since = "1.0.0", note = "text")]
         pub fn method_deprecated_text(&self) {}
 
         #[unstable(feature = "unstable_test_feature", issue = "none")]
@@ -209,10 +209,10 @@ mod this_crate {
 
     pub trait Trait {
         #[unstable(feature = "unstable_test_feature", issue = "none")]
-        #[rustc_deprecated(since = "1.0.0", reason = "text")]
+        #[rustc_deprecated(since = "1.0.0", note = "text")]
         fn trait_deprecated(&self) {}
         #[unstable(feature = "unstable_test_feature", issue = "none")]
-        #[rustc_deprecated(since = "1.0.0", reason = "text")]
+        #[rustc_deprecated(since = "1.0.0", note = "text")]
         fn trait_deprecated_text(&self) {}
 
         #[unstable(feature = "unstable_test_feature", issue = "none")]
@@ -229,7 +229,7 @@ mod this_crate {
     impl Trait for MethodTester {}
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub struct DeprecatedStruct {
         #[stable(feature = "stable_test_feature", since = "1.0.0")] i: isize
     }
@@ -243,7 +243,7 @@ mod this_crate {
     }
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub struct DeprecatedUnitStruct;
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     pub struct UnstableUnitStruct;
@@ -252,7 +252,7 @@ mod this_crate {
 
     pub enum Enum {
         #[unstable(feature = "unstable_test_feature", issue = "none")]
-        #[rustc_deprecated(since = "1.0.0", reason = "text")]
+        #[rustc_deprecated(since = "1.0.0", note = "text")]
         DeprecatedVariant,
         #[unstable(feature = "unstable_test_feature", issue = "none")]
         UnstableVariant,
@@ -262,7 +262,7 @@ mod this_crate {
     }
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub struct DeprecatedTupleStruct(isize);
     #[unstable(feature = "unstable_test_feature", issue = "none")]
     pub struct UnstableTupleStruct(isize);
@@ -382,23 +382,23 @@ mod this_crate {
     }
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     fn test_fn_body() {
         fn fn_in_body() {}
         fn_in_body();
     }
 
     impl MethodTester {
         #[unstable(feature = "unstable_test_feature", issue = "none")]
-        #[rustc_deprecated(since = "1.0.0", reason = "text")]
+        #[rustc_deprecated(since = "1.0.0", note = "text")]
         fn test_method_body(&self) {
             fn fn_in_body() {}
             fn_in_body();
         }
     }
 
     #[unstable(feature = "unstable_test_feature", issue = "none")]
-    #[rustc_deprecated(since = "1.0.0", reason = "text")]
+    #[rustc_deprecated(since = "1.0.0", note = "text")]
     pub trait DeprecatedTrait {
         fn dummy(&self) { }
     }