From 945ed665a2b4851bdf25ce32f76a749027aa6669 Mon Sep 17 00:00:00 2001
From: Eric Huss <eric@huss.org>
Date: Fri, 7 Jun 2024 08:27:30 -0700
Subject: [PATCH] Add 2024 unsafe functions

---
 src/SUMMARY.md                    |  1 +
 src/rust-2024/unsafe-functions.md | 63 +++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+)
 create mode 100644 src/rust-2024/unsafe-functions.md

diff --git a/src/SUMMARY.md b/src/SUMMARY.md
index f5a9b1a1..4c9db8a4 100644
--- a/src/SUMMARY.md
+++ b/src/SUMMARY.md
@@ -39,6 +39,7 @@
 
 - [Rust 2024 🚧](rust-2024/index.md)
   - [Additions to the prelude](rust-2024/prelude.md)
+  - [Unsafe functions](rust-2024/unsafe-functions.md)
   - [`unsafe_op_in_unsafe_fn` warning](rust-2024/unsafe-op-in-unsafe-fn.md)
   - [RPIT lifetime capture](rust-2024/rpit-lifetime-capture.md)
   - [Disallow references to `static mut`](rust-2024/static-mut-reference.md)
diff --git a/src/rust-2024/unsafe-functions.md b/src/rust-2024/unsafe-functions.md
new file mode 100644
index 00000000..ef830e7d
--- /dev/null
+++ b/src/rust-2024/unsafe-functions.md
@@ -0,0 +1,63 @@
+# Unsafe functions
+
+🚧 The 2024 Edition has not yet been released and hence this section is still "under construction".
+More information may be found in the tracking issue at <https://github.com/rust-lang/rust/issues/124866>.
+
+## Summary
+
+- The following functions are now marked [`unsafe`]:
+    - [`std::env::set_var`]
+    - [`std::env::remove_var`]
+
+[`unsafe`]: ../../reference/unsafe-keyword.html#unsafe-functions-unsafe-fn
+[`std::env::set_var`]: ../../std/env/fn.set_var.html
+[`std::env::remove_var`]: ../../std/env/fn.remove_var.html
+
+## Details
+
+It can be unsound to call [`std::env::set_var`] or [`std::env::remove_var`] in a multi-threaded program due to safety limitations of the way the process environment is handled on some platforms. The standard library originally defined these as safe functions, but it was later determined that was not correct.
+
+It is important to ensure that these functions are not called in a multi-threaded program. See the [Safety] section of the function documentation for more details.
+
+Ordinarily it would be a backwards-incompatible change to add `unsafe` to these functions. To address that problem, they are marked as `unsafe` only in the 2024 Edition.
+
+[Safety]: ../../std/env/fn.set_var.html#safety
+
+## Migration
+
+To make your code compile in both the 2021 and 2024 editions, you will need to make sure that `set_var` and `remove_var` is called from an `unsafe` blocks.
+
+**⚠ Caution**: It is important that you manually inspect the calls to `set_var` and `remove_var` and possibly rewrite your code to satisfy the preconditions of those functions. In particular, they should not be called if there might be multiple threads running. You may need to elect to use a different mechanism other than environment variables to manage your use case.
+
+The [`deprecated_safe_2024`] lint will automatically modify any use of `set_var` or `remove_var` to be wrapped in an `unsafe` block so that it can compile on both editions. This lint is part of the `rust-2024-compatibility` lint group, which will automatically be applied when running `cargo fix --edition`. To migrate your code to be Rust 2024 Edition compatible, run:
+
+```sh
+cargo fix --edition
+```
+
+For example, this will change:
+
+```rust
+fn main() {
+    std::env::set_var("FOO", "123");
+}
+```
+
+to be:
+
+```rust
+fn main() {
+    unsafe { std::env::set_var("FOO", "123") };
+}
+```
+
+Just beware that this automatic migration will not be able to verify that these functions are being used correctly. It is still your responsibility to manually review their usage.
+
+Alternatively, you can manually enable the lint to find places these functions are called:
+
+```rust
+// Add this to the root of your crate to do a manual migration.
+#![warn(deprecated_safe_2024)]
+```
+
+[`deprecated_safe_2024`]: ../../rustc/lints/listing/allowed-by-default.html#deprecated-safe