post-1.14.0 fixes

[oweals/busybox.git] / include / libbb.h

diff --git a/include/libbb.h b/include/libbb.h
index 1faa9e9fd28ef8ea11e83d48d22b2b70906a47b1..2868eba036c466399e6b73ef983690d61d80d10e 100644 (file)
--- a/include/libbb.h
+++ b/include/libbb.h
@@ -965,6 +965,12 @@ enum {
        /* How long the longest ESC sequence we know? */
        KEYCODE_BUFFER_SIZE = 4
 };
+/* Note: fd may be in blocking or non-blocking mode, both make sense.
+ * For one, less uses non-blocking mode.
+ * Only the first read syscall inside read_key may block indefinitely
+ * (unless fd is in non-blocking mode),
+ * subsequent reads will time out after a few milliseconds.
+ */
 int read_key(int fd, smalluint *nbuffered, char *buffer) FAST_FUNC;