diff options
| author | Poul T Lomholt <ptlomholt@users.noreply.github.com> | 2025-05-15 00:12:36 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-15 09:12:36 +0200 |
| commit | a3b8cb9cc0410b3f40972179b1b430e3a450002a (patch) | |
| tree | a0cda8599f6380747d76369f3e4802112ed62211 | |
| parent | 8d4218dcd7ac30a510caec3da50374b517ede425 (diff) | |
| download | libuv-a3b8cb9cc0410b3f40972179b1b430e3a450002a.tar.gz libuv-a3b8cb9cc0410b3f40972179b1b430e3a450002a.zip | |
doc: don't mention UV_LOOP_ENABLE_IO_URING_SQPOLL (#4786)
The documentation is referring to an internal name -
UV_LOOP_ENABLE_IO_URING_SQPOLL - in several places. Fix this by using
the public UV_LOOP_USE_IO_URING_SQPOLL name instead.
| -rw-r--r-- | docs/src/fs.rst | 2 | ||||
| -rw-r--r-- | docs/src/loop.rst | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/src/fs.rst b/docs/src/fs.rst index 01a48e8e..def76725 100644 --- a/docs/src/fs.rst +++ b/docs/src/fs.rst @@ -19,7 +19,7 @@ observable behavior. Libuv reverts to using its threadpool when the necessary kernel features are unavailable or unsuitable. Starting with libuv v1.49.0 this behavior was reverted and Libuv on Linux by default will be using the threadpool again. In order to enable io_uring the :c:type:`uv_loop_t` instance must be -configured with the :c:type:`UV_LOOP_ENABLE_IO_URING_SQPOLL` option. +configured with the :c:type:`UV_LOOP_USE_IO_URING_SQPOLL` option. .. note:: On Windows `uv_fs_*` functions use utf-8 encoding. diff --git a/docs/src/loop.rst b/docs/src/loop.rst index d1f41e1c..3d1973ba 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -86,12 +86,12 @@ API This option is necessary to use :c:func:`uv_metrics_idle_time`. - - UV_LOOP_ENABLE_IO_URING_SQPOLL: Enable SQPOLL io_uring instance to handle + - UV_LOOP_USE_IO_URING_SQPOLL: Enable SQPOLL io_uring instance to handle asynchronous file system operations. .. versionchanged:: 1.39.0 added the UV_METRICS_IDLE_TIME option. - .. versionchanged:: 1.49.0 added the UV_LOOP_ENABLE_IO_URING_SQPOLL option. + .. versionchanged:: 1.49.0 added the UV_LOOP_USE_IO_URING_SQPOLL option. .. c:function:: int uv_loop_close(uv_loop_t* loop) |