Auto merge of #8138 - r00ster91:safety, r=giraffate

bors · bors · commit 790513056f8f · 2021-12-20T00:15:18.000Z
Fix `SAFETY` comment tag casing in undocumented_unsafe_blocks This changes the lint introduced in #7748 to suggest adding a `SAFETY` comment instead of a `Safety` comment. Searching for `// Safety:` in rust-lang/rust yields 67 results while `// SAFETY:` yields 1072. I think it's safe to say that this comment tag is written in upper case, just like `TODO`, `FIXME` and so on are. As such I would expect this lint to follow the official convention as well. Note that I intentionally introduced some casing diversity in `tests/ui/undocumented_unsafe_blocks.rs` to test more cases than just `Safety:`. changelog: Capitalize `SAFETY` comment in [`undocumented_unsafe_blocks`]
diff --git a/clippy_lints/src/undocumented_unsafe_blocks.rs b/clippy_lints/src/undocumented_unsafe_blocks.rs
@@ -15,7 +15,7 @@ use std::borrow::Cow;
 
 declare_clippy_lint! {
     /// ### What it does
-    /// Checks for `unsafe` blocks without a `// Safety: ` comment
+    /// Checks for `unsafe` blocks without a `// SAFETY: ` comment
     /// explaining why the unsafe operations performed inside
     /// the block are safe.
     ///
@@ -36,7 +36,7 @@ declare_clippy_lint! {
     /// use std::ptr::NonNull;
     /// let a = &mut 42;
     ///
-    /// // Safety: references are guaranteed to be non-null.
+    /// // SAFETY: references are guaranteed to be non-null.
     /// let ptr = unsafe { NonNull::new_unchecked(a) };
     /// ```
     #[clippy::version = "1.58.0"]
@@ -213,7 +213,7 @@ impl UndocumentedUnsafeBlocks {
             );
         } else {
             let block_indent = indent_of(cx, span);
-            let suggestion = format!("// Safety: ...\n{}", snippet(cx, span, ".."));
+            let suggestion = format!("// SAFETY: ...\n{}", snippet(cx, span, ".."));
 
             span_lint_and_sugg(
                 cx,
diff --git a/tests/ui/crashes/ice-7868.stderr b/tests/ui/crashes/ice-7868.stderr
@@ -7,7 +7,7 @@ LL |     unsafe { 0 };
    = note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL ~     unsafe { 0 };
    |
 
diff --git a/tests/ui/undocumented_unsafe_blocks.rs b/tests/ui/undocumented_unsafe_blocks.rs
@@ -5,7 +5,7 @@
 fn nested_local() {
     let _ = {
         let _ = {
-            // Safety:
+            // SAFETY:
             let _ = unsafe {};
         };
     };
@@ -14,7 +14,7 @@ fn nested_local() {
 fn deep_nest() {
     let _ = {
         let _ = {
-            // Safety:
+            // SAFETY:
             let _ = unsafe {};
 
             // Safety:
@@ -28,7 +28,7 @@ fn deep_nest() {
                                 // Safety:
                                 let _ = unsafe {};
 
-                                // Safety:
+                                // SAFETY:
                                 unsafe {};
                             };
                         };
@@ -44,7 +44,7 @@ fn deep_nest() {
         unsafe {};
     };
 
-    // Safety:
+    // SAFETY:
     unsafe {};
 }
 
@@ -59,7 +59,7 @@ fn line_comment() {
 }
 
 fn line_comment_newlines() {
-    // Safety:
+    // SAFETY:
 
     unsafe {}
 }
@@ -84,7 +84,7 @@ fn block_comment() {
 }
 
 fn block_comment_newlines() {
-    /* Safety: */
+    /* SAFETY: */
 
     unsafe {}
 }
@@ -96,7 +96,7 @@ fn inline_block_comment() {
 
 fn block_comment_with_extras() {
     /* This is a description
-     * Safety:
+     * SAFETY:
      */
     unsafe {}
 }
@@ -122,7 +122,7 @@ fn buried_safety() {
 }
 
 fn safety_with_prepended_text() {
-    // This is a test. Safety:
+    // This is a test. safety:
     unsafe {}
 }
 
@@ -132,7 +132,7 @@ fn local_line_comment() {
 }
 
 fn local_block_comment() {
-    /* Safety: */
+    /* SAFETY: */
     let _ = unsafe {};
 }
 
@@ -142,18 +142,18 @@ fn comment_array() {
 }
 
 fn comment_tuple() {
-    // Safety:
+    // sAFETY:
     let _ = (42, unsafe {}, "test", unsafe {});
 }
 
 fn comment_unary() {
-    // Safety:
+    // SAFETY:
     let _ = *unsafe { &42 };
 }
 
 #[allow(clippy::match_single_binding)]
 fn comment_match() {
-    // Safety:
+    // SAFETY:
     let _ = match unsafe {} {
         _ => {},
     };
@@ -177,7 +177,7 @@ fn comment_macro_call() {
     }
 
     t!(
-        // Safety:
+        // SAFETY:
         unsafe {}
     );
 }
@@ -194,18 +194,18 @@ fn comment_macro_def() {
 }
 
 fn non_ascii_comment() {
-    // ॐ᧻໒ Safety: ௵∰
+    // ॐ᧻໒ SaFeTy: ௵∰
     unsafe {};
 }
 
 fn local_commented_block() {
     let _ =
-        // Safety:
+        // safety:
         unsafe {};
 }
 
 fn local_nest() {
-    // Safety:
+    // safety:
     let _ = [(42, unsafe {}, unsafe {}), (52, unsafe {}, unsafe {})];
 }
 
@@ -267,17 +267,17 @@ fn no_comment_macro_def() {
 }
 
 fn trailing_comment() {
-    unsafe {} // Safety:
+    unsafe {} // SAFETY:
 }
 
 fn internal_comment() {
     unsafe {
-        // Safety:
+        // SAFETY:
     }
 }
 
 fn interference() {
-    // Safety
+    // SAFETY
 
     let _ = 42;
 
diff --git a/tests/ui/undocumented_unsafe_blocks.stderr b/tests/ui/undocumented_unsafe_blocks.stderr
@@ -7,7 +7,7 @@ LL |     unsafe {}
    = note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     unsafe {}
    |
 
@@ -19,7 +19,7 @@ LL |     let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];
    |
 
@@ -31,7 +31,7 @@ LL |     let _ = (42, unsafe {}, "test", unsafe {});
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     let _ = (42, unsafe {}, "test", unsafe {});
    |
 
@@ -43,7 +43,7 @@ LL |     let _ = *unsafe { &42 };
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     let _ = *unsafe { &42 };
    |
 
@@ -55,7 +55,7 @@ LL |     let _ = match unsafe {} {
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     let _ = match unsafe {} {
    |
 
@@ -67,7 +67,7 @@ LL |     let _ = &unsafe {};
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     let _ = &unsafe {};
    |
 
@@ -79,7 +79,7 @@ LL |     let _ = [unsafe {}; 5];
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     let _ = [unsafe {}; 5];
    |
 
@@ -91,7 +91,7 @@ LL |     let _ = unsafe {};
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     let _ = unsafe {};
    |
 
@@ -103,7 +103,7 @@ LL |     t!(unsafe {});
    |
 help: consider adding a safety comment
    |
-LL ~     t!(// Safety: ...
+LL ~     t!(// SAFETY: ...
 LL ~     unsafe {});
    |
 
@@ -122,13 +122,13 @@ LL |     t!();
 error: unsafe block missing a safety comment
   --> $DIR/undocumented_unsafe_blocks.rs:270:5
    |
-LL |     unsafe {} // Safety:
+LL |     unsafe {} // SAFETY:
    |     ^^^^^^^^^
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
-LL ~     unsafe {} // Safety:
+LL ~     // SAFETY: ...
+LL ~     unsafe {} // SAFETY:
    |
 
 error: unsafe block missing a safety comment
@@ -139,7 +139,7 @@ LL |     unsafe {
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL +     unsafe {
    |
 
@@ -151,7 +151,7 @@ LL |     unsafe {};
    |
 help: consider adding a safety comment
    |
-LL ~     // Safety: ...
+LL ~     // SAFETY: ...
 LL ~     unsafe {};
    |
 
@@ -163,7 +163,7 @@ LL |     println!("{}", unsafe { String::from_utf8_unchecked(vec![]) });
    |
 help: consider adding a safety comment
    |
-LL ~     println!("{}", // Safety: ...
+LL ~     println!("{}", // SAFETY: ...
 LL ~     unsafe { String::from_utf8_unchecked(vec![]) });
    |
 

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ LL \| unsafe { 0 };`
`7`	`7`	= note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
`8`	`8`	`help: consider adding a safety comment`
`9`	`9`	`\|`
`10`		`-LL ~ // Safety: ...`
	`10`	`+LL ~ // SAFETY: ...`
`11`	`11`	`LL ~ unsafe { 0 };`
`12`	`12`	`\|`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`fn nested_local() {`
`6`	`6`	`let _ = {`
`7`	`7`	`let _ = {`
`8`		`- // Safety:`
	`8`	`+ // SAFETY:`
`9`	`9`	`let _ = unsafe {};`
`10`	`10`	`};`
`11`	`11`	`};`
`@@ -14,7 +14,7 @@ fn nested_local() {`
`14`	`14`	`fn deep_nest() {`
`15`	`15`	`let _ = {`
`16`	`16`	`let _ = {`
`17`		`- // Safety:`
	`17`	`+ // SAFETY:`
`18`	`18`	`let _ = unsafe {};`
`19`	`19`
`20`	`20`	`// Safety:`
`@@ -28,7 +28,7 @@ fn deep_nest() {`
`28`	`28`	`// Safety:`
`29`	`29`	`let _ = unsafe {};`
`30`	`30`
`31`		`- // Safety:`
	`31`	`+ // SAFETY:`
`32`	`32`	`unsafe {};`
`33`	`33`	`};`
`34`	`34`	`};`
`@@ -44,7 +44,7 @@ fn deep_nest() {`
`44`	`44`	`unsafe {};`
`45`	`45`	`};`
`46`	`46`
`47`		`- // Safety:`
	`47`	`+ // SAFETY:`
`48`	`48`	`unsafe {};`
`49`	`49`	`}`
`50`	`50`
`@@ -59,7 +59,7 @@ fn line_comment() {`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`fn line_comment_newlines() {`
`62`		`- // Safety:`
	`62`	`+ // SAFETY:`
`63`	`63`
`64`	`64`	`unsafe {}`
`65`	`65`	`}`
`@@ -84,7 +84,7 @@ fn block_comment() {`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`fn block_comment_newlines() {`
`87`		`- /* Safety: */`
	`87`	`+ /* SAFETY: */`
`88`	`88`
`89`	`89`	`unsafe {}`
`90`	`90`	`}`
`@@ -96,7 +96,7 @@ fn inline_block_comment() {`
`96`	`96`
`97`	`97`	`fn block_comment_with_extras() {`
`98`	`98`	`/* This is a description`
`99`		`- * Safety:`
	`99`	`+ * SAFETY:`
`100`	`100`	`*/`
`101`	`101`	`unsafe {}`
`102`	`102`	`}`
`@@ -122,7 +122,7 @@ fn buried_safety() {`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`fn safety_with_prepended_text() {`
`125`		`- // This is a test. Safety:`
	`125`	`+ // This is a test. safety:`
`126`	`126`	`unsafe {}`
`127`	`127`	`}`
`128`	`128`
`@@ -132,7 +132,7 @@ fn local_line_comment() {`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`fn local_block_comment() {`
`135`		`- /* Safety: */`
	`135`	`+ /* SAFETY: */`
`136`	`136`	`let _ = unsafe {};`
`137`	`137`	`}`
`138`	`138`
`@@ -142,18 +142,18 @@ fn comment_array() {`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`fn comment_tuple() {`
`145`		`- // Safety:`
	`145`	`+ // sAFETY:`
`146`	`146`	`let _ = (42, unsafe {}, "test", unsafe {});`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`fn comment_unary() {`
`150`		`- // Safety:`
	`150`	`+ // SAFETY:`
`151`	`151`	`let _ = *unsafe { &42 };`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`#[allow(clippy::match_single_binding)]`
`155`	`155`	`fn comment_match() {`
`156`		`- // Safety:`
	`156`	`+ // SAFETY:`
`157`	`157`	`let _ = match unsafe {} {`
`158`	`158`	`_ => {},`
`159`	`159`	`};`
`@@ -177,7 +177,7 @@ fn comment_macro_call() {`
`177`	`177`	`}`
`178`	`178`
`179`	`179`	`t!(`
`180`		`- // Safety:`
	`180`	`+ // SAFETY:`
`181`	`181`	`unsafe {}`
`182`	`182`	`);`
`183`	`183`	`}`
`@@ -194,18 +194,18 @@ fn comment_macro_def() {`
`194`	`194`	`}`
`195`	`195`
`196`	`196`	`fn non_ascii_comment() {`
`197`		`- // ॐ᧻໒ Safety: ௵∰`
	`197`	`+ // ॐ᧻໒ SaFeTy: ௵∰`
`198`	`198`	`unsafe {};`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`fn local_commented_block() {`
`202`	`202`	`let _ =`
`203`		`- // Safety:`
	`203`	`+ // safety:`
`204`	`204`	`unsafe {};`
`205`	`205`	`}`
`206`	`206`
`207`	`207`	`fn local_nest() {`
`208`		`- // Safety:`
	`208`	`+ // safety:`
`209`	`209`	`let _ = [(42, unsafe {}, unsafe {}), (52, unsafe {}, unsafe {})];`
`210`	`210`	`}`
`211`	`211`
`@@ -267,17 +267,17 @@ fn no_comment_macro_def() {`
`267`	`267`	`}`
`268`	`268`
`269`	`269`	`fn trailing_comment() {`
`270`		`- unsafe {} // Safety:`
	`270`	`+ unsafe {} // SAFETY:`
`271`	`271`	`}`
`272`	`272`
`273`	`273`	`fn internal_comment() {`
`274`	`274`	`unsafe {`
`275`		`- // Safety:`
	`275`	`+ // SAFETY:`
`276`	`276`	`}`
`277`	`277`	`}`
`278`	`278`
`279`	`279`	`fn interference() {`
`280`		`- // Safety`
	`280`	`+ // SAFETY`
`281`	`281`
`282`	`282`	`let _ = 42;`
`283`	`283`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ LL \| unsafe {}`
`7`	`7`	= note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
`8`	`8`	`help: consider adding a safety comment`
`9`	`9`	`\|`
`10`		`-LL ~ // Safety: ...`
	`10`	`+LL ~ // SAFETY: ...`
`11`	`11`	`LL + unsafe {}`
`12`	`12`	`\|`
`13`	`13`
`@@ -19,7 +19,7 @@ LL \| let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];`
`19`	`19`	`\|`
`20`	`20`	`help: consider adding a safety comment`
`21`	`21`	`\|`
`22`		`-LL ~ // Safety: ...`
	`22`	`+LL ~ // SAFETY: ...`
`23`	`23`	`LL + let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];`
`24`	`24`	`\|`
`25`	`25`
`@@ -31,7 +31,7 @@ LL \| let _ = (42, unsafe {}, "test", unsafe {});`
`31`	`31`	`\|`
`32`	`32`	`help: consider adding a safety comment`
`33`	`33`	`\|`
`34`		`-LL ~ // Safety: ...`
	`34`	`+LL ~ // SAFETY: ...`
`35`	`35`	`LL + let _ = (42, unsafe {}, "test", unsafe {});`
`36`	`36`	`\|`
`37`	`37`
`@@ -43,7 +43,7 @@ LL \| let _ = *unsafe { &42 };`
`43`	`43`	`\|`
`44`	`44`	`help: consider adding a safety comment`
`45`	`45`	`\|`
`46`		`-LL ~ // Safety: ...`
	`46`	`+LL ~ // SAFETY: ...`
`47`	`47`	`LL + let _ = *unsafe { &42 };`
`48`	`48`	`\|`
`49`	`49`
`@@ -55,7 +55,7 @@ LL \| let _ = match unsafe {} {`
`55`	`55`	`\|`
`56`	`56`	`help: consider adding a safety comment`
`57`	`57`	`\|`
`58`		`-LL ~ // Safety: ...`
	`58`	`+LL ~ // SAFETY: ...`
`59`	`59`	`LL + let _ = match unsafe {} {`
`60`	`60`	`\|`
`61`	`61`
`@@ -67,7 +67,7 @@ LL \| let _ = &unsafe {};`
`67`	`67`	`\|`
`68`	`68`	`help: consider adding a safety comment`
`69`	`69`	`\|`
`70`		`-LL ~ // Safety: ...`
	`70`	`+LL ~ // SAFETY: ...`
`71`	`71`	`LL + let _ = &unsafe {};`
`72`	`72`	`\|`
`73`	`73`
`@@ -79,7 +79,7 @@ LL \| let _ = [unsafe {}; 5];`
`79`	`79`	`\|`
`80`	`80`	`help: consider adding a safety comment`
`81`	`81`	`\|`
`82`		`-LL ~ // Safety: ...`
	`82`	`+LL ~ // SAFETY: ...`
`83`	`83`	`LL + let _ = [unsafe {}; 5];`
`84`	`84`	`\|`
`85`	`85`
`@@ -91,7 +91,7 @@ LL \| let _ = unsafe {};`
`91`	`91`	`\|`
`92`	`92`	`help: consider adding a safety comment`
`93`	`93`	`\|`
`94`		`-LL ~ // Safety: ...`
	`94`	`+LL ~ // SAFETY: ...`
`95`	`95`	`LL + let _ = unsafe {};`
`96`	`96`	`\|`
`97`	`97`
`@@ -103,7 +103,7 @@ LL \| t!(unsafe {});`
`103`	`103`	`\|`
`104`	`104`	`help: consider adding a safety comment`
`105`	`105`	`\|`
`106`		`-LL ~ t!(// Safety: ...`
	`106`	`+LL ~ t!(// SAFETY: ...`
`107`	`107`	`LL ~ unsafe {});`
`108`	`108`	`\|`
`109`	`109`
`@@ -122,13 +122,13 @@ LL \| t!();`
`122`	`122`	`error: unsafe block missing a safety comment`
`123`	`123`	`--> $DIR/undocumented_unsafe_blocks.rs:270:5`
`124`	`124`	`\|`
`125`		`-LL \| unsafe {} // Safety:`
	`125`	`+LL \| unsafe {} // SAFETY:`
`126`	`126`	`\| ^^^^^^^^^`
`127`	`127`	`\|`
`128`	`128`	`help: consider adding a safety comment`
`129`	`129`	`\|`
`130`		`-LL ~ // Safety: ...`
`131`		`-LL ~ unsafe {} // Safety:`
	`130`	`+LL ~ // SAFETY: ...`
	`131`	`+LL ~ unsafe {} // SAFETY:`
`132`	`132`	`\|`
`133`	`133`
`134`	`134`	`error: unsafe block missing a safety comment`
`@@ -139,7 +139,7 @@ LL \| unsafe {`
`139`	`139`	`\|`
`140`	`140`	`help: consider adding a safety comment`
`141`	`141`	`\|`
`142`		`-LL ~ // Safety: ...`
	`142`	`+LL ~ // SAFETY: ...`
`143`	`143`	`LL + unsafe {`
`144`	`144`	`\|`
`145`	`145`
`@@ -151,7 +151,7 @@ LL \| unsafe {};`
`151`	`151`	`\|`
`152`	`152`	`help: consider adding a safety comment`
`153`	`153`	`\|`
`154`		`-LL ~ // Safety: ...`
	`154`	`+LL ~ // SAFETY: ...`
`155`	`155`	`LL ~ unsafe {};`
`156`	`156`	`\|`
`157`	`157`
`@@ -163,7 +163,7 @@ LL \| println!("{}", unsafe { String::from_utf8_unchecked(vec![]) });`
`163`	`163`	`\|`
`164`	`164`	`help: consider adding a safety comment`
`165`	`165`	`\|`
`166`		`-LL ~ println!("{}", // Safety: ...`
	`166`	`+LL ~ println!("{}", // SAFETY: ...`
`167`	`167`	`LL ~ unsafe { String::from_utf8_unchecked(vec![]) });`
`168`	`168`	`\|`
`169`	`169`