From 6a5377ac14bec2f2ae62c4ec085ff3b149cc11ad Mon Sep 17 00:00:00 2001
From: Denis Vlasenko
Date: Tue, 25 Sep 2007 18:35:28 +0000
Subject: documentation bits in comments, no code changes

---
 include/libbb.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'include')

diff --git a/include/libbb.h b/include/libbb.h
index 25b2e44..407b723 100644
--- a/include/libbb.h
+++ b/include/libbb.h
@@ -892,6 +892,12 @@ enum {
 	FOR_SHELL = DO_HISTORY | SAVE_HISTORY | TAB_COMPLETION | USERNAME_COMPLETION,
 };
 line_input_t *new_line_input_t(int flags);
+/* Returns:
+ * -1 on read errors or EOF, or on bare Ctrl-D.
+ * 0  on ctrl-C,
+ * >0 length of input string, including terminating '\n'
+ * [is this true? stores "" in 'command' if return value is 0 or -1]
+ */
 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *state);
 #else
 int read_line_input(const char* prompt, char* command, int maxsize);
-- 
cgit v1.1