aboutsummaryrefslogtreecommitdiff
path: root/docs/src
Commit message (Collapse)AuthorAge
* doc: remove note about SIGWINCH on WindowsBartosz Sosnowski2017-11-28
| | | | | | | | | SIGWINCH support was improved by https://github.com/libuv/libuv/commit/6ad1e81547c83f9fe7c5a806b6b282642e8d3bca PR-URL: https://github.com/libuv/libuv/pull/1638 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* win: map UV_FS_O_EXLOCK to a share mode of 0Joran Dirk Greef2017-11-16
| | | | | | | | This is necessary to enable writing past the MBR of a raw block device. Fixes: https://github.com/libuv/libuv/issues/1605 PR-URL: https://github.com/libuv/libuv/pull/1613 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
* doc: clarify the description of uv_loop_alive()Ed Schouten2017-11-15
| | | | | | | | | | | | This function not only returns true if there are active handles or requests. First of all, it also takes into account whether handles are referenced. Second, handles that are being closed also contribute to whether a loop is alive. Fixes: https://github.com/libuv/libuv/issues/1592 PR-URL: https://github.com/libuv/libuv/pull/1594 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* unix,win: add uv_if_{indextoname,indextoiid}Pekka Nikander2017-11-06
| | | | | | | | | | | | | | | uv_if_indextoname() is used to convert an IPv6 scope_id to an interface identifier string such as %eth0 or %lo. uv_if_indextoiid() returns an IPv6 interface identifier. On Unix it calls uv_if_indextoname(). On Windows it uses snprintf() to return the numeric interface identifier as a string. Refs: https://github.com/nodejs/node/pull/14500 PR-URL: https://github.com/libuv/libuv/pull/1445 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* pipe: allow access from other usersBartosz Sosnowski2017-11-06
| | | | | | | | | Adds new uv_pipe_chmod function which can be used to make the pipe writable or readable by all users. PR-URL: https://github.com/libuv/libuv/pull/1386 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: mark uv_default_loop() as not thread saferayrase2017-11-01
| | | | | | Fixes: https://github.com/libuv/libuv/issues/1461 PR-URL: https://github.com/libuv/libuv/pull/1590 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* unix,win: add uv_os_getppid()cjihrig2017-11-01
| | | | | | | | Refs: https://github.com/nodejs/node/issues/14957 PR-URL: https://github.com/libuv/libuv/pull/1610 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
* unix,win: add fs open flags, map O_DIRECT|O_DSYNCJoran Dirk Greef2017-10-03
| | | | | | | | | | | | Define stable cross-platform file open constants so that users can pass `UV_FS_O_RDWR` rather than `_O_RDWR` (win) or `O_RDWR` (unix). Map `UV_FS_O_DIRECT`, `UV_FS_O_DSYNC` and `UV_FS_O_SYNC` to `FILE_FLAG_NO_BUFFERING` and `FILE_FLAG_WRITE_THROUGH` (win). Fixes: https://github.com/libuv/libuv/issues/1550 PR-URL: https://github.com/libuv/libuv/pull/1567 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
* unix,win: add uv_mutex_init_recursive()Scott Parker2017-10-02
| | | | | | | | | | | Support the creation of recursive mutexes on Unix. A matching API is added on Windows, however mutexes on Windows are always recursive. Refs: https://github.com/libuv/libuv/issues/1022 PR-URL: https://github.com/libuv/libuv/pull/1555 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: fix a trivial typoVladimír Čunát2017-09-01
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1516 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* unix, windows: add basic uv_fs_copyfile()cjihrig2017-08-15
| | | | | | | | | Fixes: https://github.com/libuv/libuv/issues/925 PR-URL: https://github.com/libuv/libuv/pull/1465 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* doc: document uv_async_(init|send) return valuesBen Noordhuis2017-07-27
| | | | | | | Fixes: https://github.com/libuv/libuv/issues/576 PR-URL: https://github.com/libuv/libuv/pull/1435 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* docs: fix guide source code example pathsAnticrisis2017-07-25
| | | | | | | | | 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>
* poll: add support for OOB TCP and GPIO interruptsCurlyMoo2017-07-12
| | | | | | | | | | | | | | | Out-of-band TCP messages are used for TCP data transmission outside (outband) the inbound TCP data. These packets are sent with an "urgent pointer", but previously discarded. Additionally, when using (e)poll a POLLPRI is triggered when an interrupt signal is received on GPIO capable systems such as the Raspberry Pi. PR-URL: https://github.com/libuv/libuv/pull/1040 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: add thread safety warning for process titleMatthew Taylor2017-07-12
| | | | | | | | | | | | | Add a small warning about uv_get_process_title() and uv_set_process_title() not being thread safe on platforms other than Windows. Also add a reminder for users to call uv_setup_args() first. Fixes: https://github.com/libuv/libuv/issues/1395 PR-URL: https://github.com/libuv/libuv/pull/1396 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* win: make uv__get_osfhandle() publicJuan Cruz Viotti2017-05-30
| | | | | | | | | | | | | | | | | | | | The uv__get_osfhandle() function is a private functio of the Windows subsystem, and its used to get a Windows HANDLE out of a file descriptor number. The motivation behind making this function public is to allow Node.js programs to pass file descriptors created using fs.open() to native Node.js C++ add-ons, and be able to successfully convert them to Windows HANDLEs. Refs: https://github.com/libuv/libuv/pull/1166 Refs: https://github.com/nodejs/node/issues/6369 Fixes: https://github.com/libuv/libuv/issues/1291 PR-URL: https://github.com/libuv/libuv/pull/1323 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: mark uv_loop_fork() as experimentalcjihrig2017-05-25
| | | | | | | | | | | | | uv_loop_fork() was recently added, but is known to contain bugs. This commit marks the function as experimental so that bugs can be addressed without blocking further libuv releases. Refs: https://github.com/libuv/libuv/pull/846 Refs: https://github.com/libuv/libuv/pull/1269 Refs: https://github.com/libuv/libuv/issues/1264 PR-URL: https://github.com/libuv/libuv/pull/1356 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* unix,win: add uv_os_gethostname()cjihrig2017-05-18
| | | | | | | Fixes: https://github.com/libuv/libuv/issues/1315 PR-URL: https://github.com/libuv/libuv/pull/1342 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
* doc: add warning note to user guideSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: remove licensing note from guide/aboutSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: update guide/about and mention new maintainershipSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: removed unused fileSaúl Ibarra Corretgé2017-04-28
| | | | | | | | We use guide.rst as our index, so there is no need for a secondary one. PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: add initial version of the User GuideSaúl Ibarra Corretgé2017-04-28
| | | | | | | | | 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>
* doc: move "upgrading" to a standalone documentSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: move documentation section upSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: move TOC to a dedicated documentSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: update copyright yearsSaúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: rename docs to "libuv documentation"Saúl Ibarra Corretgé2017-04-28
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1246 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: fix documentation for uv_handle_t.typeDaniel Kahn Gillmor2017-04-25
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1316 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: libuv does not touch uv_loop_t.dataBen Noordhuis2017-04-18
| | | | | | | | | Mea culpa, I forgot to update the documentation in commit ff0ae10 ("unix: preserve loop->data across loop init/done") from July 2016. PR-URL: https://github.com/libuv/libuv/pull/1299 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: suggestions for design pageDaniel Bevenius2017-04-12
| | | | | | | | | | While reading the design page I came across a few sentences that could perhaps be improved, and this commit contains suggestions for such improvements. PR-URL: https://github.com/libuv/libuv/pull/1302 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: minor grammar fix in Installation sectionDaniel Bevenius2017-04-11
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1301 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: fix docs/src/fs.rst build warningDaniel Bevenius2017-04-11
| | | | | | | | | This commit fixes a warning about the title underline being too short. PR-URL: https://github.com/libuv/libuv/pull/1300 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: fix multiple doc typosJamie Davis2017-04-01
| | | | | | | | | | Use "file system" instead of "filesystem" throughout the document and some other minor fixes. PR-URL: https://github.com/libuv/libuv/pull/1278 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
* unix: make loops and watchers usable after fork()Jason Madden2017-03-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Added the uv_loop_fork() API that must be called in a child process to continue using an existing loop. Internally this calls a uv__io_fork function for each supported platform, similar to the way uv__platform_loop_init works. After this call, existing and new IO, async and signal watchers will contiue working as before on all platforms, as will the threadpool (although any threads it was using are of course gone). On Linux and BSDs that use kqueue, existing and new fsevent watchers will also continue to work as expected. On OS X, though, directory fsevents will not be able to use the optimized CoreFoundation path if they had already been used in the parent process, instead falling back to the kqueue path used on other BSDs. Existing fsevent watchers will not function on AIX or SunOS. This could be relatively easily fixed by someone with AIX knowledge in the future, but SunOS will require some additional work to keep track if the watchers. A new test file, test/test-fork.c, was added to contain fork-related tests to verify functionality in the child process. PR-URL: https://github.com/libuv/libuv/pull/846 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* docs: improve UV_ENOBUFS scenario documentationcjihrig2017-03-08
| | | | | | | | | This commit adds additional documentation to the UV_ENOBUFS scenario for several methods. Fixes: https://github.com/libuv/libuv/issues/1179 PR-URL: https://github.com/libuv/libuv/pull/1235 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* unix,win: add uv_os_{get,set,unset}env()cjihrig2017-03-08
| | | | | | | | | | These functions are used to create, retrieve, update, and delete environment variables. Fixes: https://github.com/libuv/libuv/issues/1198 PR-URL: https://github.com/libuv/libuv/pull/1234 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* signal: add uv_signal_start_oneshot methodSantiago Gimeno2017-02-28
| | | | | | | | | | | It behaves as `uv_signal_start` but it resets the signal handler as soon as the signal is received. Fixes: https://github.com/libuv/libuv/issues/1104 PR-URL: https://github.com/libuv/libuv/pull/1106 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
* aix: enable uv_get/set_process_titleHoward Hellyer2017-01-26
| | | | | | | | | | | | | | | | | | This patch enables querying and setting the process title on AIX. libuv takes ownership of the memory for argv and returns a deep copy of the array and its contents. It also enables the process_title test case. The process title can be changed on AIX but is handled differently to Linux/Mac. Commands like ps read the original argv array passed to the process instead of the memory at argv[0]. To change the process title we need to update argv[0] to point at a new string and set argv[1] to NULL (if it exists). This means the process title can be set to a string of any length. PR-URL: https://github.com/libuv/libuv/pull/1187 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: add repitition qualifier to version regexsDaniel Bevenius2017-01-20
| | | | | | | | | | | | Currently the libuv version is reported as unknown on the website. This is because the UV_VERSION_MINOR is no longer a single digit and the regex is not getting a match for the minor number. This commit makes the version regexs capture multiple digit numbers. PR-URL: https://github.com/libuv/libuv/pull/1205 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: fix wrong man page link for uv_fs_lstat()Michele Caini2016-11-11
| | | | | | | PR-URL: https://github.com/libuv/libuv/pull/1134 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Imran Iqbal <imran@imraniqbal.org>
* unix,win: add uv_translate_sys_error() public APIPhilippe Laferriere2016-10-16
| | | | | | | | | | | | | | | uv_translate_sys_error() was a private function for Windows. This commit adds an equivalent function on other platforms, and exposes it as public API. Exposing this is useful in scenarios where the application uses both libuv functions and platform-specific system calls and wants to report errors uniformly as libuv errors. Fixes: https://github.com/libuv/libuv/issues/79 PR-URL: https://github.com/libuv/libuv/pull/1060 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: add reference to uv_update_time on uv_timer_startAlex Hultman2016-10-14
| | | | | | PR-URL: https://github.com/libuv/libuv/pull/1079 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: note buffer lifetime requirements in uv_writeVladimír Čunát2016-10-09
| | | | | | | | Fixes: https://github.com/libuv/libuv/issues/1072 PR-URL: https://github.com/libuv/libuv/pull/1074 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: add description of uv_handle_typeVit Gottwald2016-09-22
| | | | | | Fixes: https://github.com/libuv/libuv/issues/1044 PR-URL: https://github.com/libuv/libuv/pull/1059 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: fix confusing doc of uv_tcp_nodelayBart Robinson2016-09-15
| | | | | | | | Previous description implied enabling nodelay enabled Nagle, but it is the other way around. PR-URL: https://github.com/libuv/libuv/pull/1050 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
* doc: update supported fields for uv_rusage_tImran Iqbal2016-09-11
| | | | | | | Fixes: https://github.com/libuv/libuv/issues/342 PR-URL: https://github.com/libuv/libuv/pull/1041 Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: improve documentation on uv_alloc_cbSaúl Ibarra Corretgé2016-09-07
| | | | | | | | | Refs: https://github.com/libuv/libuv/issues/1027#issuecomment-244386298 PR-URL: https://github.com/libuv/libuv/pull/1033 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: Imran Iqbal <imran@imraniqbal.org> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: uv_buf_t members are not readonlySaúl Ibarra Corretgé2016-09-07
| | | | | | | | | | | | This is probably a reminiscent of the usage in libuv 0.x, where alloc_cb used to return a uv_buf_t. Refs: https://github.com/libuv/libuv/issues/1027#issuecomment-244386298 PR-URL: https://github.com/libuv/libuv/pull/1033 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor@indutny.com> Reviewed-By: Imran Iqbal <imran@imraniqbal.org> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
* doc: document uv_fs_realpath caveatsSaúl Ibarra Corretgé2016-09-02
| | | | | | | Fixes: https://github.com/libuv/libuv/issues/1017 PR-URL: https://github.com/libuv/libuv/pull/1026 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Imran Iqbal <imran@imraniqbal.org>
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-21 10:06:30 +0000