From 85d662476847f0e96767a27cb5166a7233200aa4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Wed, 7 Jan 2015 09:38:20 +0100 Subject: [PATCH] doc: clarify the behavior of uv_tty_init Closes #120 PR-URL: https://github.com/libuv/libuv/pull/121 Reviewed-By: Ben Noordhuis --- docs/src/tty.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/src/tty.rst b/docs/src/tty.rst index 74b48594..6c20c84b 100644 --- a/docs/src/tty.rst +++ b/docs/src/tty.rst @@ -58,8 +58,13 @@ API `readable`, specifies if you plan on calling :c:func:`uv_read_start` with this stream. stdin is readable, stdout is not. + On Unix this function will try to open ``/dev/tty`` and use it if the passed file + descriptor refers to a TTY. This lets libuv put the tty in non-blocking mode + without affecting other processes that share the tty. + .. note:: - TTY streams which are not readable have blocking writes. + If opening ``/dev/tty`` fails, libuv falls back to blocking writes for non-readable + TTY streams. .. c:function:: int uv_tty_set_mode(uv_tty_t*, uv_tty_mode_t mode)