aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
author握猫猫 <164346864@qq.com>2024-08-15 17:01:20 +0800
committerGitHub <noreply@github.com>2024-08-15 11:01:20 +0200
commit1790abb3b233d87a947074a79e8ea68bd3885862 (patch)
treec617dc6b309262c924a0c41a64415ebfdd23df34 /docs/src
parent31d91659998a2f34395ab44c89940262e71dca22 (diff)
downloadlibuv-1790abb3b233d87a947074a79e8ea68bd3885862.tar.gz
libuv-1790abb3b233d87a947074a79e8ea68bd3885862.zip
doc: document uv_loop_option
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/loop.rst13
-rw-r--r--docs/src/misc.rst6
-rw-r--r--docs/src/request.rst24
3 files changed, 30 insertions, 13 deletions
diff --git a/docs/src/loop.rst b/docs/src/loop.rst
index dc26e654..c5ec1d7a 100644
--- a/docs/src/loop.rst
+++ b/docs/src/loop.rst
@@ -16,6 +16,19 @@ Data types
Loop data type.
+.. c:enum:: uv_loop_option
+
+ Additional loop options.
+ See :c:func:`uv_loop_configure`.
+
+ ::
+
+ typedef enum {
+ UV_LOOP_BLOCK_SIGNAL = 0,
+ UV_METRICS_IDLE_TIME,
+ UV_LOOP_USE_IO_URING_SQPOLL
+ } uv_loop_option;
+
.. c:enum:: uv_run_mode
Mode used to run the loop with :c:func:`uv_run`.
diff --git a/docs/src/misc.rst b/docs/src/misc.rst
index 239fc176..61883b7e 100644
--- a/docs/src/misc.rst
+++ b/docs/src/misc.rst
@@ -199,7 +199,7 @@ Data types
char* homedir;
} uv_passwd_t;
-.. c:type:: uv_group_s
+.. c:type:: uv_group_t
Data type for group file information.
@@ -209,7 +209,7 @@ Data types
char* groupname;
unsigned long gid;
char** members;
- };
+ } uv_group_t;
.. c:type:: uv_utsname_t
@@ -590,7 +590,7 @@ API
.. versionadded:: 1.45.0
-.. c:function:: int uv_os_get_group(uv_group_s* group, uv_uid_t gid)
+.. c:function:: int uv_os_get_group(uv_group_t* group, uv_uid_t gid)
Gets a subset of the group file entry for the provided uid.
The populated data includes the group name, gid, and members. On non-Windows
diff --git a/docs/src/request.rst b/docs/src/request.rst
index a0414431..a5b9c7f4 100644
--- a/docs/src/request.rst
+++ b/docs/src/request.rst
@@ -21,17 +21,9 @@ Data types
Union of all request types.
+.. c:enum:: uv_req_type
-Public members
-^^^^^^^^^^^^^^
-
-.. c:member:: void* uv_req_t.data
-
- Space for user-defined arbitrary data. libuv does not use this field.
-
-.. c:member:: uv_req_type uv_req_t.type
-
- Indicated the type of request. Readonly.
+ The kind of the libuv request.
::
@@ -50,6 +42,18 @@ Public members
} uv_req_type;
+Public members
+^^^^^^^^^^^^^^
+
+.. c:member:: void* uv_req_t.data
+
+ Space for user-defined arbitrary data. libuv does not use this field.
+
+.. c:member:: uv_req_type uv_req_t.type
+
+ The :c:type:`uv_req_type`, indicating the type of the request. Readonly.
+
+
API
---