From 043bc88f73f07a15a39e072e1130caf0ba84ab2c Mon Sep 17 00:00:00 2001
From: Rob Ede <robjtede@icloud.com>
Date: Fri, 15 Sep 2023 22:20:43 +0100
Subject: [PATCH] docs: add note about rt::spawn compat with tokio::main

---
 actix-web/src/rt.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/actix-web/src/rt.rs b/actix-web/src/rt.rs
index 629ffe3a0..e370e2c0b 100644
--- a/actix-web/src/rt.rs
+++ b/actix-web/src/rt.rs
@@ -5,6 +5,7 @@
 //! architecture in [`actix-rt`]'s docs.
 //!
 //! # Running Actix Web Without Macros
+//!
 //! ```no_run
 //! use actix_web::{middleware, rt, web, App, HttpRequest, HttpServer};
 //!
@@ -25,6 +26,7 @@
 //! ```
 //!
 //! # Running Actix Web Using `#[tokio::main]`
+//!
 //! If you need to run something that uses Tokio's work stealing functionality alongside Actix Web,
 //! you can run Actix Web under `#[tokio::main]`. The [`Server`](crate::dev::Server) object returned
 //! from [`HttpServer::run`](crate::HttpServer::run) can also be [`spawn`]ed, if preferred.
@@ -32,6 +34,10 @@
 //! Note that `actix` actor support (and therefore WebSocket support through `actix-web-actors`)
 //! still require `#[actix_web::main]` since they require a [`System`] to be set up.
 //!
+//! Also note that calls to this module's [`spawn()`] re-export require an `#[actix_web::main]`
+//! runtime (or a manually configured `LocalSet`) since it makes calls into to the current thread's
+//! `LocalSet`, which `#[tokio::main]` does not set up.
+//!
 //! ```no_run
 //! use actix_web::{get, middleware, rt, web, App, HttpRequest, HttpServer};
 //!