From 0f628c942d73ca97c83fe29ee2ffe4dd4201ef51 Mon Sep 17 00:00:00 2001
From: Adam Reichold <adam.reichold@t-online.de>
Date: Wed, 24 May 2023 09:45:15 +0200
Subject: [PATCH] Be more explicit of the soundness hole implied by tying Ungil
 to Send and mention the available solution.

---
 src/marker.rs | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/src/marker.rs b/src/marker.rs
index 77518842..c6d6fc40 100644
--- a/src/marker.rs
+++ b/src/marker.rs
@@ -148,6 +148,8 @@ use std::os::raw::c_int;
 ///
 /// ```compile_fail
 /// # use pyo3::prelude::*;
+/// use std::rc::Rc;
+///
 /// Python::with_gil(|py| {
 ///     let rc = Rc::new(42);
 ///
@@ -157,7 +159,8 @@ use std::os::raw::c_int;
 /// });
 /// ```
 ///
-/// This also implies that one can circumvent this protection using e.g. the [`send_wrapper`](https://docs.rs/send_wrapper/) crate:
+/// This also implies that the interplay between `with_gil` and `allow_threads` is unsound, for example
+/// one can circumvent this protection using the [`send_wrapper`](https://docs.rs/send_wrapper/) crate:
 ///
 /// ```no_run
 /// # use pyo3::prelude::*;
@@ -176,6 +179,9 @@ use std::os::raw::c_int;
 ///     });
 /// });
 /// ```
+///
+/// Fixing this loophole on stable Rust has significant ergonomic issues, but it is fixed when using
+/// nightly Rust and the `nightly` feature, c.f. [#2141](https://github.com/PyO3/pyo3/issues/2141).
 #[cfg_attr(docsrs, doc(cfg(all())))] // Hide the cfg flag
 #[cfg(not(feature = "nightly"))]
 pub unsafe trait Ungil {}
@@ -240,6 +246,22 @@ unsafe impl<T: Send> Ungil for T {}
 ///     });
 /// });
 /// ```
+///
+/// This also enables using non-[`Send`] types in `allow_threads`,
+/// at least if they are not also bound to the GIL:
+///
+/// ```rust
+/// # use pyo3::prelude::*;
+/// use std::rc::Rc;
+///
+/// Python::with_gil(|py| {
+///     let rc = Rc::new(42);
+///
+///     py.allow_threads(|| {
+///         println!("{:?}", rc);
+///     });
+/// });
+/// ```
 #[cfg(feature = "nightly")]
 pub unsafe auto trait Ungil {}