mirror of
https://github.com/rust-lang/rust.git
synced 2025-02-22 03:44:24 +00:00
Fix SAFETY comment tag casing in undocumented_unsafe_blocks
This commit is contained in:
parent
a3bf9d1dcf
commit
eba441391d
@ -15,7 +15,7 @@ use std::borrow::Cow;
|
|||||||
|
|
||||||
declare_clippy_lint! {
|
declare_clippy_lint! {
|
||||||
/// ### What it does
|
/// ### 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
|
/// explaining why the unsafe operations performed inside
|
||||||
/// the block are safe.
|
/// the block are safe.
|
||||||
///
|
///
|
||||||
@ -36,7 +36,7 @@ declare_clippy_lint! {
|
|||||||
/// use std::ptr::NonNull;
|
/// use std::ptr::NonNull;
|
||||||
/// let a = &mut 42;
|
/// 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) };
|
/// let ptr = unsafe { NonNull::new_unchecked(a) };
|
||||||
/// ```
|
/// ```
|
||||||
#[clippy::version = "1.58.0"]
|
#[clippy::version = "1.58.0"]
|
||||||
@ -213,7 +213,7 @@ impl UndocumentedUnsafeBlocks {
|
|||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
let block_indent = indent_of(cx, span);
|
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(
|
span_lint_and_sugg(
|
||||||
cx,
|
cx,
|
||||||
|
@ -7,7 +7,7 @@ LL | unsafe { 0 };
|
|||||||
= note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
|
= note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL ~ unsafe { 0 };
|
LL ~ unsafe { 0 };
|
||||||
|
|
|
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
fn nested_local() {
|
fn nested_local() {
|
||||||
let _ = {
|
let _ = {
|
||||||
let _ = {
|
let _ = {
|
||||||
// Safety:
|
// SAFETY:
|
||||||
let _ = unsafe {};
|
let _ = unsafe {};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
@ -14,7 +14,7 @@ fn nested_local() {
|
|||||||
fn deep_nest() {
|
fn deep_nest() {
|
||||||
let _ = {
|
let _ = {
|
||||||
let _ = {
|
let _ = {
|
||||||
// Safety:
|
// SAFETY:
|
||||||
let _ = unsafe {};
|
let _ = unsafe {};
|
||||||
|
|
||||||
// Safety:
|
// Safety:
|
||||||
@ -28,7 +28,7 @@ fn deep_nest() {
|
|||||||
// Safety:
|
// Safety:
|
||||||
let _ = unsafe {};
|
let _ = unsafe {};
|
||||||
|
|
||||||
// Safety:
|
// SAFETY:
|
||||||
unsafe {};
|
unsafe {};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
@ -44,7 +44,7 @@ fn deep_nest() {
|
|||||||
unsafe {};
|
unsafe {};
|
||||||
};
|
};
|
||||||
|
|
||||||
// Safety:
|
// SAFETY:
|
||||||
unsafe {};
|
unsafe {};
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -59,7 +59,7 @@ fn line_comment() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn line_comment_newlines() {
|
fn line_comment_newlines() {
|
||||||
// Safety:
|
// SAFETY:
|
||||||
|
|
||||||
unsafe {}
|
unsafe {}
|
||||||
}
|
}
|
||||||
@ -84,7 +84,7 @@ fn block_comment() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn block_comment_newlines() {
|
fn block_comment_newlines() {
|
||||||
/* Safety: */
|
/* SAFETY: */
|
||||||
|
|
||||||
unsafe {}
|
unsafe {}
|
||||||
}
|
}
|
||||||
@ -96,7 +96,7 @@ fn inline_block_comment() {
|
|||||||
|
|
||||||
fn block_comment_with_extras() {
|
fn block_comment_with_extras() {
|
||||||
/* This is a description
|
/* This is a description
|
||||||
* Safety:
|
* SAFETY:
|
||||||
*/
|
*/
|
||||||
unsafe {}
|
unsafe {}
|
||||||
}
|
}
|
||||||
@ -122,7 +122,7 @@ fn buried_safety() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn safety_with_prepended_text() {
|
fn safety_with_prepended_text() {
|
||||||
// This is a test. Safety:
|
// This is a test. safety:
|
||||||
unsafe {}
|
unsafe {}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -132,7 +132,7 @@ fn local_line_comment() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn local_block_comment() {
|
fn local_block_comment() {
|
||||||
/* Safety: */
|
/* SAFETY: */
|
||||||
let _ = unsafe {};
|
let _ = unsafe {};
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -142,18 +142,18 @@ fn comment_array() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn comment_tuple() {
|
fn comment_tuple() {
|
||||||
// Safety:
|
// sAFETY:
|
||||||
let _ = (42, unsafe {}, "test", unsafe {});
|
let _ = (42, unsafe {}, "test", unsafe {});
|
||||||
}
|
}
|
||||||
|
|
||||||
fn comment_unary() {
|
fn comment_unary() {
|
||||||
// Safety:
|
// SAFETY:
|
||||||
let _ = *unsafe { &42 };
|
let _ = *unsafe { &42 };
|
||||||
}
|
}
|
||||||
|
|
||||||
#[allow(clippy::match_single_binding)]
|
#[allow(clippy::match_single_binding)]
|
||||||
fn comment_match() {
|
fn comment_match() {
|
||||||
// Safety:
|
// SAFETY:
|
||||||
let _ = match unsafe {} {
|
let _ = match unsafe {} {
|
||||||
_ => {},
|
_ => {},
|
||||||
};
|
};
|
||||||
@ -177,7 +177,7 @@ fn comment_macro_call() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
t!(
|
t!(
|
||||||
// Safety:
|
// SAFETY:
|
||||||
unsafe {}
|
unsafe {}
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
@ -194,18 +194,18 @@ fn comment_macro_def() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn non_ascii_comment() {
|
fn non_ascii_comment() {
|
||||||
// ॐ᧻໒ Safety: ௵∰
|
// ॐ᧻໒ SaFeTy: ௵∰
|
||||||
unsafe {};
|
unsafe {};
|
||||||
}
|
}
|
||||||
|
|
||||||
fn local_commented_block() {
|
fn local_commented_block() {
|
||||||
let _ =
|
let _ =
|
||||||
// Safety:
|
// safety:
|
||||||
unsafe {};
|
unsafe {};
|
||||||
}
|
}
|
||||||
|
|
||||||
fn local_nest() {
|
fn local_nest() {
|
||||||
// Safety:
|
// safety:
|
||||||
let _ = [(42, unsafe {}, unsafe {}), (52, unsafe {}, unsafe {})];
|
let _ = [(42, unsafe {}, unsafe {}), (52, unsafe {}, unsafe {})];
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -267,17 +267,17 @@ fn no_comment_macro_def() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn trailing_comment() {
|
fn trailing_comment() {
|
||||||
unsafe {} // Safety:
|
unsafe {} // SAFETY:
|
||||||
}
|
}
|
||||||
|
|
||||||
fn internal_comment() {
|
fn internal_comment() {
|
||||||
unsafe {
|
unsafe {
|
||||||
// Safety:
|
// SAFETY:
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn interference() {
|
fn interference() {
|
||||||
// Safety
|
// SAFETY
|
||||||
|
|
||||||
let _ = 42;
|
let _ = 42;
|
||||||
|
|
||||||
|
@ -7,7 +7,7 @@ LL | unsafe {}
|
|||||||
= note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
|
= note: `-D clippy::undocumented-unsafe-blocks` implied by `-D warnings`
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + unsafe {}
|
LL + unsafe {}
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -19,7 +19,7 @@ LL | let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + let _ = [unsafe { 14 }, unsafe { 15 }, 42, unsafe { 16 }];
|
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
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + let _ = (42, unsafe {}, "test", unsafe {});
|
LL + let _ = (42, unsafe {}, "test", unsafe {});
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -43,7 +43,7 @@ LL | let _ = *unsafe { &42 };
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + let _ = *unsafe { &42 };
|
LL + let _ = *unsafe { &42 };
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -55,7 +55,7 @@ LL | let _ = match unsafe {} {
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + let _ = match unsafe {} {
|
LL + let _ = match unsafe {} {
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -67,7 +67,7 @@ LL | let _ = &unsafe {};
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + let _ = &unsafe {};
|
LL + let _ = &unsafe {};
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -79,7 +79,7 @@ LL | let _ = [unsafe {}; 5];
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + let _ = [unsafe {}; 5];
|
LL + let _ = [unsafe {}; 5];
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -91,7 +91,7 @@ LL | let _ = unsafe {};
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + let _ = unsafe {};
|
LL + let _ = unsafe {};
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -103,7 +103,7 @@ LL | t!(unsafe {});
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ t!(// Safety: ...
|
LL ~ t!(// SAFETY: ...
|
||||||
LL ~ unsafe {});
|
LL ~ unsafe {});
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -122,13 +122,13 @@ LL | t!();
|
|||||||
error: unsafe block missing a safety comment
|
error: unsafe block missing a safety comment
|
||||||
--> $DIR/undocumented_unsafe_blocks.rs:270:5
|
--> $DIR/undocumented_unsafe_blocks.rs:270:5
|
||||||
|
|
|
|
||||||
LL | unsafe {} // Safety:
|
LL | unsafe {} // SAFETY:
|
||||||
| ^^^^^^^^^
|
| ^^^^^^^^^
|
||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL ~ unsafe {} // Safety:
|
LL ~ unsafe {} // SAFETY:
|
||||||
|
|
|
|
||||||
|
|
||||||
error: unsafe block missing a safety comment
|
error: unsafe block missing a safety comment
|
||||||
@ -139,7 +139,7 @@ LL | unsafe {
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL + unsafe {
|
LL + unsafe {
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -151,7 +151,7 @@ LL | unsafe {};
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ // Safety: ...
|
LL ~ // SAFETY: ...
|
||||||
LL ~ unsafe {};
|
LL ~ unsafe {};
|
||||||
|
|
|
|
||||||
|
|
||||||
@ -163,7 +163,7 @@ LL | println!("{}", unsafe { String::from_utf8_unchecked(vec![]) });
|
|||||||
|
|
|
|
||||||
help: consider adding a safety comment
|
help: consider adding a safety comment
|
||||||
|
|
|
|
||||||
LL ~ println!("{}", // Safety: ...
|
LL ~ println!("{}", // SAFETY: ...
|
||||||
LL ~ unsafe { String::from_utf8_unchecked(vec![]) });
|
LL ~ unsafe { String::from_utf8_unchecked(vec![]) });
|
||||||
|
|
|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user