diff options
| author | Thomas Versteeg <thomasversteeg@gmx.com> | 2018-03-02 10:41:08 +0000 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2018-04-07 14:26:26 -0400 |
| commit | 9afb013574e9a988e6fb3365c164fd8250dbaaa6 (patch) | |
| tree | 1d312074f48dcf16ccde6a0b4adc1b11fef28c05 /docs/src/guide/processes.rst | |
| parent | 61a8d97ad9eff8a5e8b0d05d3b421062cd5427de (diff) | |
| download | libuv-9afb013574e9a988e6fb3365c164fd8250dbaaa6.tar.gz libuv-9afb013574e9a988e6fb3365c164fd8250dbaaa6.zip | |
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>
Diffstat (limited to 'docs/src/guide/processes.rst')
| -rw-r--r-- | docs/src/guide/processes.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/src/guide/processes.rst b/docs/src/guide/processes.rst index 49df4e93..19ce0572 100644 --- a/docs/src/guide/processes.rst +++ b/docs/src/guide/processes.rst @@ -290,7 +290,9 @@ A client which wants to connect to a domain socket will use:: void uv_pipe_connect(uv_connect_t *req, uv_pipe_t *handle, const char *name, uv_connect_cb cb); -where ``name`` will be ``echo.sock`` or similar. +where ``name`` will be ``echo.sock`` or similar. On Unix systems, ``name`` must +point to a valid file (e.g. ``/tmp/echo.sock``). On Windows, ``name`` follows a +``\\?\pipe\echo.sock`` format. .. _socat: http://www.dest-unreach.org/socat/ |