diff options
author | Nhan Khong <knhana7@gmail.com> | 2019-06-27 20:14:09 +0700 |
---|---|---|
committer | Saúl Ibarra Corretgé <s@saghul.net> | 2019-09-25 14:39:23 +0200 |
commit | 75075d6cdbd79e83a27a3047cb7b86cbb5026aa0 (patch) | |
tree | 99763e0f2e5053ebea8946f81dab4023e2fa7a07 /docs/src/guide/basics.rst | |
parent | 9b2c9b6c1f457be5015f6f651730c93c63c06fe7 (diff) | |
download | libuv-75075d6cdbd79e83a27a3047cb7b86cbb5026aa0.tar.gz libuv-75075d6cdbd79e83a27a3047cb7b86cbb5026aa0.zip |
docs: fix literal-includes in User Guide
Using raw copies in place of sphinx literalinclude
directives as the API of v1.x is now stable.
Fixes: https://github.com/libuv/libuv/issues/2350
PR-URL: https://github.com/libuv/libuv/pull/2353
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Saúl Ibarra Corretgé <s@saghul.net>
Diffstat (limited to 'docs/src/guide/basics.rst')
-rw-r--r-- | docs/src/guide/basics.rst | 35 |
1 files changed, 33 insertions, 2 deletions
diff --git a/docs/src/guide/basics.rst b/docs/src/guide/basics.rst index a0e41414..1da8d5ef 100644 --- a/docs/src/guide/basics.rst +++ b/docs/src/guide/basics.rst @@ -136,8 +136,39 @@ Handles are opaque structs named as ``uv_TYPE_t`` where type signifies what the handle is used for. .. rubric:: libuv watchers -.. literalinclude:: ../../../include/uv.h - :lines: 197-230 +.. code-block:: c + + /* Handle types. */ + typedef struct uv_loop_s uv_loop_t; + typedef struct uv_handle_s uv_handle_t; + typedef struct uv_dir_s uv_dir_t; + typedef struct uv_stream_s uv_stream_t; + typedef struct uv_tcp_s uv_tcp_t; + typedef struct uv_udp_s uv_udp_t; + typedef struct uv_pipe_s uv_pipe_t; + typedef struct uv_tty_s uv_tty_t; + typedef struct uv_poll_s uv_poll_t; + typedef struct uv_timer_s uv_timer_t; + typedef struct uv_prepare_s uv_prepare_t; + typedef struct uv_check_s uv_check_t; + typedef struct uv_idle_s uv_idle_t; + typedef struct uv_async_s uv_async_t; + typedef struct uv_process_s uv_process_t; + typedef struct uv_fs_event_s uv_fs_event_t; + typedef struct uv_fs_poll_s uv_fs_poll_t; + typedef struct uv_signal_s uv_signal_t; + + /* Request types. */ + typedef struct uv_req_s uv_req_t; + typedef struct uv_getaddrinfo_s uv_getaddrinfo_t; + typedef struct uv_getnameinfo_s uv_getnameinfo_t; + typedef struct uv_shutdown_s uv_shutdown_t; + typedef struct uv_write_s uv_write_t; + typedef struct uv_connect_s uv_connect_t; + typedef struct uv_udp_send_s uv_udp_send_t; + typedef struct uv_fs_s uv_fs_t; + typedef struct uv_work_s uv_work_t; + Handles represent long-lived objects. Async operations on such handles are identified using **requests**. A request is short-lived (usually used across |