Add a couple of examples to undocumented_unsafe_blocks

Jarcho · Jarcho · commit 17c8bee95a43 · 2022-04-02T00:46:45.000-04:00
diff --git a/clippy_lints/src/undocumented_unsafe_blocks.rs b/clippy_lints/src/undocumented_unsafe_blocks.rs
@@ -15,6 +15,24 @@ declare_clippy_lint! {
     /// explaining why the unsafe operations performed inside
     /// the block are safe.
     ///
+    /// Note the comment must appear on the line(s) preceding the unsafe block
+    /// with nothing appearing in between. The following is ok:
+    /// ```ignore
+    /// foo(
+    ///     // SAFETY:
+    ///     // This is a valid safety comment
+    ///     unsafe { *x }
+    /// )
+    /// ```
+    /// But neither of these are:
+    /// ```ignore
+    /// // SAFETY:
+    /// // This is not a valid safety comment
+    /// foo(
+    ///     /* SAFETY: Neither is this */ unsafe { *x },
+    /// );
+    /// ```
+    ///
     /// ### Why is this bad?
     /// Undocumented unsafe blocks can make it difficult to
     /// read and maintain code, as well as uncover unsoundness
diff --git a/tests/ui/undocumented_unsafe_blocks.rs b/tests/ui/undocumented_unsafe_blocks.rs
@@ -251,6 +251,11 @@ fn from_proc_macro() {
 
 // Invalid comments
 
+#[rustfmt::skip]
+fn inline_block_comment() {
+    /* Safety: */ unsafe {}
+}
+
 fn no_comment() {
     unsafe {}
 }
diff --git a/tests/ui/undocumented_unsafe_blocks.stderr b/tests/ui/undocumented_unsafe_blocks.stderr
@@ -1,102 +1,110 @@
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:255:5
+  --> $DIR/undocumented_unsafe_blocks.rs:256:19
+   |
+LL |     /* Safety: */ unsafe {}
+   |                   ^^^^^^^^^
+   |
+   = note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
+   = help: consider adding a safety comment on the preceding line
+
+error: unsafe block missing a safety comment
+  --> $DIR/undocumented_unsafe_blocks.rs:260:5
    |
 LL |     unsafe {}
    |     ^^^^^^^^^
    |
-   = note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:259:14
+  --> $DIR/undocumented_unsafe_blocks.rs:264:14
    |
 LL |     let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];
    |              ^^^^^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:259:29
+  --> $DIR/undocumented_unsafe_blocks.rs:264:29
    |
 LL |     let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];
    |                             ^^^^^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:259:48
+  --> $DIR/undocumented_unsafe_blocks.rs:264:48
    |
 LL |     let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];
    |                                                ^^^^^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:263:18
+  --> $DIR/undocumented_unsafe_blocks.rs:268:18
    |
 LL |     let _ = (42, unsafe {}, "test", unsafe {});
    |                  ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:263:37
+  --> $DIR/undocumented_unsafe_blocks.rs:268:37
    |
 LL |     let _ = (42, unsafe {}, "test", unsafe {});
    |                                     ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:267:14
+  --> $DIR/undocumented_unsafe_blocks.rs:272:14
    |
 LL |     let _ = *unsafe { &42 };
    |              ^^^^^^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:272:19
+  --> $DIR/undocumented_unsafe_blocks.rs:277:19
    |
 LL |     let _ = match unsafe {} {
    |                   ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:278:14
+  --> $DIR/undocumented_unsafe_blocks.rs:283:14
    |
 LL |     let _ = &unsafe {};
    |              ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:282:14
+  --> $DIR/undocumented_unsafe_blocks.rs:287:14
    |
 LL |     let _ = [unsafe {}; 5];
    |              ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:286:13
+  --> $DIR/undocumented_unsafe_blocks.rs:291:13
    |
 LL |     let _ = unsafe {};
    |             ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:296:8
+  --> $DIR/undocumented_unsafe_blocks.rs:301:8
    |
 LL |     t!(unsafe {});
    |        ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:302:13
+  --> $DIR/undocumented_unsafe_blocks.rs:307:13
    |
 LL |             unsafe {}
    |             ^^^^^^^^^
@@ -108,36 +116,36 @@ LL |     t!();
    = note: this error originates in the macro `t` (in Nightly builds, run with -Z macro-backtrace for more info)
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:310:5
+  --> $DIR/undocumented_unsafe_blocks.rs:315:5
    |
 LL |     unsafe {} // SAFETY:
    |     ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:314:5
+  --> $DIR/undocumented_unsafe_blocks.rs:319:5
    |
 LL |     unsafe {
    |     ^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:324:5
+  --> $DIR/undocumented_unsafe_blocks.rs:329:5
    |
 LL |     unsafe {};
    |     ^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
 error: unsafe block missing a safety comment
-  --> $DIR/undocumented_unsafe_blocks.rs:328:20
+  --> $DIR/undocumented_unsafe_blocks.rs:333:20
    |
 LL |     println!("{}", unsafe { String::from_utf8_unchecked(vec![]) });
    |                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = help: consider adding a safety comment on the preceding line
 
-error: aborting due to 17 previous errors
+error: aborting due to 18 previous errors
 

Original file line number	Diff line number	Diff line change
`@@ -1,102 +1,110 @@`
`1`	`1`	`error: unsafe block missing a safety comment`
`2`		`- --> $DIR/undocumented_unsafe_blocks.rs:255:5`
	`2`	`+ --> $DIR/undocumented_unsafe_blocks.rs:256:19`
	`3`	`+ \|`
	`4`	`+LL \| /* Safety: */ unsafe {}`
	`5`	`+ \| ^^^^^^^^^`
	`6`	`+ \|`
	`7`	+ = note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
	`8`	`+ = help: consider adding a safety comment on the preceding line`
	`9`	`+`
	`10`	`+error: unsafe block missing a safety comment`
	`11`	`+ --> $DIR/undocumented_unsafe_blocks.rs:260:5`
`3`	`12`	`\|`
`4`	`13`	`LL \| unsafe {}`
`5`	`14`	`\| ^^^^^^^^^`
`6`	`15`	`\|`
`7`		- = note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
`8`	`16`	`= help: consider adding a safety comment on the preceding line`
`9`	`17`
`10`	`18`	`error: unsafe block missing a safety comment`
`11`		`- --> $DIR/undocumented_unsafe_blocks.rs:259:14`
	`19`	`+ --> $DIR/undocumented_unsafe_blocks.rs:264:14`
`12`	`20`	`\|`
`13`	`21`	`LL \| let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];`
`14`	`22`	`\| ^^^^^^^^^^^^^`
`15`	`23`	`\|`
`16`	`24`	`= help: consider adding a safety comment on the preceding line`
`17`	`25`
`18`	`26`	`error: unsafe block missing a safety comment`
`19`		`- --> $DIR/undocumented_unsafe_blocks.rs:259:29`
	`27`	`+ --> $DIR/undocumented_unsafe_blocks.rs:264:29`
`20`	`28`	`\|`
`21`	`29`	`LL \| let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];`
`22`	`30`	`\| ^^^^^^^^^^^^^`
`23`	`31`	`\|`
`24`	`32`	`= help: consider adding a safety comment on the preceding line`
`25`	`33`
`26`	`34`	`error: unsafe block missing a safety comment`
`27`		`- --> $DIR/undocumented_unsafe_blocks.rs:259:48`
	`35`	`+ --> $DIR/undocumented_unsafe_blocks.rs:264:48`
`28`	`36`	`\|`
`29`	`37`	`LL \| let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];`
`30`	`38`	`\| ^^^^^^^^^^^^^`
`31`	`39`	`\|`
`32`	`40`	`= help: consider adding a safety comment on the preceding line`
`33`	`41`
`34`	`42`	`error: unsafe block missing a safety comment`
`35`		`- --> $DIR/undocumented_unsafe_blocks.rs:263:18`
	`43`	`+ --> $DIR/undocumented_unsafe_blocks.rs:268:18`
`36`	`44`	`\|`
`37`	`45`	`LL \| let _ = (42, unsafe {}, "test", unsafe {});`
`38`	`46`	`\| ^^^^^^^^^`
`39`	`47`	`\|`
`40`	`48`	`= help: consider adding a safety comment on the preceding line`
`41`	`49`
`42`	`50`	`error: unsafe block missing a safety comment`
`43`		`- --> $DIR/undocumented_unsafe_blocks.rs:263:37`
	`51`	`+ --> $DIR/undocumented_unsafe_blocks.rs:268:37`
`44`	`52`	`\|`
`45`	`53`	`LL \| let _ = (42, unsafe {}, "test", unsafe {});`
`46`	`54`	`\| ^^^^^^^^^`
`47`	`55`	`\|`
`48`	`56`	`= help: consider adding a safety comment on the preceding line`
`49`	`57`
`50`	`58`	`error: unsafe block missing a safety comment`
`51`		`- --> $DIR/undocumented_unsafe_blocks.rs:267:14`
	`59`	`+ --> $DIR/undocumented_unsafe_blocks.rs:272:14`
`52`	`60`	`\|`
`53`	`61`	`LL \| let _ = *unsafe { &42 };`
`54`	`62`	`\| ^^^^^^^^^^^^^^`
`55`	`63`	`\|`
`56`	`64`	`= help: consider adding a safety comment on the preceding line`
`57`	`65`
`58`	`66`	`error: unsafe block missing a safety comment`
`59`		`- --> $DIR/undocumented_unsafe_blocks.rs:272:19`
	`67`	`+ --> $DIR/undocumented_unsafe_blocks.rs:277:19`
`60`	`68`	`\|`
`61`	`69`	`LL \| let _ = match unsafe {} {`
`62`	`70`	`\| ^^^^^^^^^`
`63`	`71`	`\|`
`64`	`72`	`= help: consider adding a safety comment on the preceding line`
`65`	`73`
`66`	`74`	`error: unsafe block missing a safety comment`
`67`		`- --> $DIR/undocumented_unsafe_blocks.rs:278:14`
	`75`	`+ --> $DIR/undocumented_unsafe_blocks.rs:283:14`
`68`	`76`	`\|`
`69`	`77`	`LL \| let _ = &unsafe {};`
`70`	`78`	`\| ^^^^^^^^^`
`71`	`79`	`\|`
`72`	`80`	`= help: consider adding a safety comment on the preceding line`
`73`	`81`
`74`	`82`	`error: unsafe block missing a safety comment`
`75`		`- --> $DIR/undocumented_unsafe_blocks.rs:282:14`
	`83`	`+ --> $DIR/undocumented_unsafe_blocks.rs:287:14`
`76`	`84`	`\|`
`77`	`85`	`LL \| let _ = [unsafe {}; 5];`
`78`	`86`	`\| ^^^^^^^^^`
`79`	`87`	`\|`
`80`	`88`	`= help: consider adding a safety comment on the preceding line`
`81`	`89`
`82`	`90`	`error: unsafe block missing a safety comment`
`83`		`- --> $DIR/undocumented_unsafe_blocks.rs:286:13`
	`91`	`+ --> $DIR/undocumented_unsafe_blocks.rs:291:13`
`84`	`92`	`\|`
`85`	`93`	`LL \| let _ = unsafe {};`
`86`	`94`	`\| ^^^^^^^^^`
`87`	`95`	`\|`
`88`	`96`	`= help: consider adding a safety comment on the preceding line`
`89`	`97`
`90`	`98`	`error: unsafe block missing a safety comment`
`91`		`- --> $DIR/undocumented_unsafe_blocks.rs:296:8`
	`99`	`+ --> $DIR/undocumented_unsafe_blocks.rs:301:8`
`92`	`100`	`\|`
`93`	`101`	`LL \| t!(unsafe {});`
`94`	`102`	`\| ^^^^^^^^^`
`95`	`103`	`\|`
`96`	`104`	`= help: consider adding a safety comment on the preceding line`
`97`	`105`
`98`	`106`	`error: unsafe block missing a safety comment`
`99`		`- --> $DIR/undocumented_unsafe_blocks.rs:302:13`
	`107`	`+ --> $DIR/undocumented_unsafe_blocks.rs:307:13`
`100`	`108`	`\|`
`101`	`109`	`LL \| unsafe {}`
`102`	`110`	`\| ^^^^^^^^^`
`@@ -108,36 +116,36 @@ LL \| t!();`
`108`	`116`	= note: this error originates in the macro `t` (in Nightly builds, run with -Z macro-backtrace for more info)
`109`	`117`
`110`	`118`	`error: unsafe block missing a safety comment`
`111`		`- --> $DIR/undocumented_unsafe_blocks.rs:310:5`
	`119`	`+ --> $DIR/undocumented_unsafe_blocks.rs:315:5`
`112`	`120`	`\|`
`113`	`121`	`LL \| unsafe {} // SAFETY:`
`114`	`122`	`\| ^^^^^^^^^`
`115`	`123`	`\|`
`116`	`124`	`= help: consider adding a safety comment on the preceding line`
`117`	`125`
`118`	`126`	`error: unsafe block missing a safety comment`
`119`		`- --> $DIR/undocumented_unsafe_blocks.rs:314:5`
	`127`	`+ --> $DIR/undocumented_unsafe_blocks.rs:319:5`
`120`	`128`	`\|`
`121`	`129`	`LL \| unsafe {`
`122`	`130`	`\| ^^^^^^^^`
`123`	`131`	`\|`
`124`	`132`	`= help: consider adding a safety comment on the preceding line`
`125`	`133`
`126`	`134`	`error: unsafe block missing a safety comment`
`127`		`- --> $DIR/undocumented_unsafe_blocks.rs:324:5`
	`135`	`+ --> $DIR/undocumented_unsafe_blocks.rs:329:5`
`128`	`136`	`\|`
`129`	`137`	`LL \| unsafe {};`
`130`	`138`	`\| ^^^^^^^^^`
`131`	`139`	`\|`
`132`	`140`	`= help: consider adding a safety comment on the preceding line`
`133`	`141`
`134`	`142`	`error: unsafe block missing a safety comment`
`135`		`- --> $DIR/undocumented_unsafe_blocks.rs:328:20`
	`143`	`+ --> $DIR/undocumented_unsafe_blocks.rs:333:20`
`136`	`144`	`\|`
`137`	`145`	`LL \| println!("{}", unsafe { String::from_utf8_unchecked(vec![]) });`
`138`	`146`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`139`	`147`	`\|`
`140`	`148`	`= help: consider adding a safety comment on the preceding line`
`141`	`149`
`142`		`-error: aborting due to 17 previous errors`
	`150`	`+error: aborting due to 18 previous errors`
`143`	`151`