Commit Graph

11 Commits

Author SHA1 Message Date
josedelinux
520eb622f0
doc: fix some typos 2024-04-26 13:57:26 +02:00
Pleuvens
dc1bb0088e
doc: uv_close should be called after exit callback (#4164)
Fixes: https://github.com/libuv/libuv/issues/1911
2023-10-14 13:07:05 +02:00
raisinten
c3d08b5d63
doc: fix code highlighting
Affected docs:
* basics.rst
* filesystem.rst
* eventloops.rst
* networking.rst
* processes.rst
* threads.rst
* utilities.rst

Fixes: https://github.com/libuv/libuv/issues/3033
PR-URL: https://github.com/libuv/libuv/pull/3082
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2021-02-14 09:13:34 +01:00
Jameson Nash
707dd7f17d
doc: fix most sphinx warnings
PR-URL: https://github.com/libuv/libuv/pull/2956
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2020-08-18 13:07:04 -04:00
Jameson Nash
02a36bb3ba docs: clarify that uv_pipe_t is a pipe
Some people have misread this section to imply that libuv does not
support Unix `pipe` objects, while it only should be saying that the
UV_CREATE_PIPE makes a socketpair. Clarify the docs to say specifically
that `uv_pipe_t` represents any local file stream.

PR-URL: https://github.com/libuv/libuv/pull/2607
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2020-01-09 10:38:02 -05:00
Jameson Nash
8cb8afe253 docs: switch from linux.die.net to man7.org
The former was missing `urandom`, while the later is the host site for
https://www.kernel.org/doc/man-pages

PR-URL: https://github.com/libuv/libuv/pull/2608
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2020-01-08 11:52:02 -05:00
Jameson Nash
c072a3846d docs: fix linkcheck
Prefer https when available, follow permanent redirects, and find
alternate sources for dead links.

PR-URL: https://github.com/libuv/libuv/pull/2608
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2020-01-08 11:51:04 -05:00
Nhan Khong
75075d6cdb 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>
2019-09-25 14:39:23 +02:00
Thomas Versteeg
9afb013574
doc: clarify platform specific pipe naming
Pipe naming conventions differ on Windows and Unix. This
commit calls out the naming conventions and requirements.

PR-URL: https://github.com/libuv/libuv/pull/1765
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
2018-04-07 14:26:26 -04:00
Anticrisis
cf38297b60 docs: fix guide source code example paths
Source code examples in the User guide were not appearing in the built
documentation because the relative paths were incorrect.

PR-URL: https://github.com/libuv/libuv/pull/1428
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
2017-07-25 00:28:17 +02:00
Saúl Ibarra Corretgé
b80106de45 doc: add initial version of the User Guide
This is a fresh import of uvbook [0], as is. It is to be considered
"beta", as the entire content hasn't been revised / adapted yet.

PR-URL: https://github.com/libuv/libuv/pull/1246
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
2017-04-28 11:15:10 +02:00