Doc section for sync module on runtime compatibility

Author: jofas

tokio/src/sync/mod.rs

@@ -431,6 +431,24 @@
 //!   number of permits, which tasks may request in order to enter a critical
 //!   section. Semaphores are useful for implementing limiting or bounding of
 //!   any kind.
+//!
+//! # Runtime compatibility
+//!
+//! All synchronization primitives provided in this module are runtime agnostic.
+//! You can freely move them between different instances of the Tokio runtime
+//! or even use them from non-Tokio runtimes.
+//!
+//! When used in a Tokio runtime, the synchronization primitives participate in
+//! [cooperative scheduling](crate::task#cooperative-scheduling),
+//! periodically yielding back control to the runtime to avoid starving it.
+//! In a non-Tokio runtime, the yield points where control is handed back do
+//! nothing, not changing the behavior of the synchronization primitive in any
+//! way.
+//!
+//! The only exception to runtime compatibility is the
+//! [`mpsc::Sender::send_timeout`] method, which can't be called from non-Tokio
+//! runtimes. However, [`Senders`](mpsc::Sender) can still be moved between
+//! different instances of the Tokio runtime.
 
 cfg_sync! {
     /// Named future types.

tokio/src/sync/mpsc/mod.rs

@@ -70,13 +70,12 @@
 //!
 //! # Multiple runtimes
 //!
-//! The mpsc channel does not care about which runtime you use it in, and can be
-//! used to send messages from one runtime to another. It can also be used in
-//! non-Tokio runtimes.
-//!
-//! There is one exception to the above: the [`send_timeout`] must be used from
-//! within a Tokio runtime, however it is still not tied to one specific Tokio
-//! runtime, and the sender may be moved from one Tokio runtime to another.
+//! The mpsc channel is runtime agnostic and can be used to send messages
+//! between different runtimes, including non-Tokio runtimes.
+//! The only exception being [`send_timeout`], which needs to be called from
+//! a Tokio runtime.
+//! For more details see
+//! [the documentation of the `sync` module](crate::sync#runtime-compatibility).
 //!
 //! # Allocation behavior
 //!