Add FIXME comment to unsafe env modification

Addresses rust-lang#124636 (comment). I think that the diff display regresses a little, because it's no longer showing the `+` to show where the `unsafe {}` is added. I think it's still fine.
tbu- · Jun 5, 2024 · e66f6fa · e66f6fa
1 parent a330e49
commit e66f6fa
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/compiler/rustc_mir_build/src/check_unsafety.rs b/compiler/rustc_mir_build/src/check_unsafety.rs
@@ -117,6 +117,7 @@ impl<'tcx> UnsafetyVisitor<'_, 'tcx> {
                     if !span.at_least_rust_2024()
                         && self.tcx.has_attr(id, sym::rustc_deprecated_safe_2024) =>
                 {
+                    let sm = self.tcx.sess.source_map();
                     self.tcx.emit_node_span_lint(
                         DEPRECATED_SAFE,
                         self.hir_context,
@@ -125,6 +126,8 @@ impl<'tcx> UnsafetyVisitor<'_, 'tcx> {
                             span,
                             function: with_no_trimmed_paths!(self.tcx.def_path_str(id)),
                             sub: CallToDeprecatedSafeFnRequiresUnsafeSub {
+                                indent: sm.indentation_before(span).unwrap_or_default(),
+                                start_of_line: sm.span_extend_to_line(span).shrink_to_lo(),
                                 left: span.shrink_to_lo(),
                                 right: span.shrink_to_hi(),
                             },

diff --git a/compiler/rustc_mir_build/src/errors.rs b/compiler/rustc_mir_build/src/errors.rs
@@ -33,6 +33,11 @@ pub(crate) struct CallToDeprecatedSafeFnRequiresUnsafe {
 #[derive(Subdiagnostic)]
 #[multipart_suggestion(mir_build_suggestion, applicability = "machine-applicable")]
 pub(crate) struct CallToDeprecatedSafeFnRequiresUnsafeSub {
+    pub(crate) indent: String,
+    #[suggestion_part(
+        code = "{indent}// FIXME: Audit that the environment access only happens in single-threaded code.\n"
+    )]
+    pub(crate) start_of_line: Span,
     #[suggestion_part(code = "unsafe {{ ")]
     pub(crate) left: Span,
     #[suggestion_part(code = " }}")]

diff --git a/tests/ui/rust-2024/unsafe-env-suggestion.fixed b/tests/ui/rust-2024/unsafe-env-suggestion.fixed
@@ -6,9 +6,11 @@ use std::env;
 
 #[deny(unused_unsafe)]
 fn main() {
+    // FIXME: Audit that the environment access only happens in single-threaded code.
     unsafe { env::set_var("FOO", "BAR") };
     //~^ ERROR call to deprecated safe function
     //~| WARN this is accepted in the current edition
+    // FIXME: Audit that the environment access only happens in single-threaded code.
     unsafe { env::remove_var("FOO") };
     //~^ ERROR call to deprecated safe function
     //~| WARN this is accepted in the current edition

diff --git a/tests/ui/rust-2024/unsafe-env-suggestion.stderr b/tests/ui/rust-2024/unsafe-env-suggestion.stderr
@@ -13,8 +13,9 @@ LL | #![deny(deprecated_safe)]
    |         ^^^^^^^^^^^^^^^
 help: you can wrap the call in an `unsafe` block if you can guarantee the code is only ever called from single-threaded code
    |
-LL |     unsafe { env::set_var("FOO", "BAR") };
-   |     ++++++++                            +
+LL +     // FIXME: Audit that the environment access only happens in single-threaded code.
+LL ~     unsafe { env::set_var("FOO", "BAR") };
+   |
 
 error: call to deprecated safe function `std::env::remove_var` is unsafe and requires unsafe block
   --> $DIR/unsafe-env-suggestion.rs:12:5
@@ -26,8 +27,9 @@ LL |     env::remove_var("FOO");
    = note: for more information, see issue #27970 <https://github.com/rust-lang/rust/issues/27970>
 help: you can wrap the call in an `unsafe` block if you can guarantee the code is only ever called from single-threaded code
    |
-LL |     unsafe { env::remove_var("FOO") };
-   |     ++++++++                        +
+LL +     // FIXME: Audit that the environment access only happens in single-threaded code.
+LL ~     unsafe { env::remove_var("FOO") };
+   |
 
 error: aborting due to 2 previous errors