aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorBen Noordhuis <info@bnoordhuis.nl>2025-04-17 19:56:19 +0200
committerGitHub <noreply@github.com>2025-04-17 19:56:19 +0200
commit11ecfbad8175dc4d754600109c7a9a5b3f30fc80 (patch)
tree231d663084817c2b3c79351e184326c035bfe901 /docs/src
parentbf6c8870dce4fb039f75561265edc9f604a8d834 (diff)
downloadlibuv-11ecfbad8175dc4d754600109c7a9a5b3f30fc80.tar.gz
libuv-11ecfbad8175dc4d754600109c7a9a5b3f30fc80.zip
doc: update thread pool stack size comment (#4756)
I changed the default stack size in commit 73b0c1f94 from October 2022 and although I added a versionchanged note, I didn't update the blurb a few lines below. It wasn't accurate before that change either though, because even with musl libc's ~80kb thread stacks, 128 threads works out to 10 MB. Refs: https://github.com/nodejs/node/issues/57911
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/threadpool.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/src/threadpool.rst b/docs/src/threadpool.rst
index 05f31d2c..d4dc5b8e 100644
--- a/docs/src/threadpool.rst
+++ b/docs/src/threadpool.rst
@@ -20,10 +20,10 @@ is 1024).
.. versionchanged:: 1.50.0 threads now have a default name of libuv-worker.
The threadpool is global and shared across all event loops. When a particular
-function makes use of the threadpool (i.e. when using :c:func:`uv_queue_work`)
+function makes use of the threadpool (e.g. when using :c:func:`uv_queue_work`)
libuv preallocates and initializes the maximum number of threads allowed by
-``UV_THREADPOOL_SIZE``. This causes a relatively minor memory overhead
-(~1MB for 128 threads) but increases the performance of threading at runtime.
+``UV_THREADPOOL_SIZE``. More threads usually means more throughput but a higher
+memory footprint. Thread stacks grow lazily on most platforms though.
.. note::
Note that even though a global thread pool which is shared across all events