documentation bits in comments, no code changes

diff --git a/editors/ed.c b/editors/ed.c
index f5b9c39bbb9947ab3a0d6395150a9eb79fa82fe2..cd3836aed5f9ba67816a6fe869cdb5d512588679 100644 (file)
--- a/editors/ed.c
+++ b/editors/ed.c
@@ -82,7 +82,6 @@ static int bad_nums(int num1, int num2, const char *for_what)
 
 static char *skip_blank(const char *cp)
 {
-// NB: fix comment in skip_whitespace!
        while (isblank(*cp))
                cp++;
        return (char *)cp;
@@ -125,7 +124,6 @@ static void doCommands(void)
        smallint have1, have2;
 
        while (TRUE) {
-// NB: fix comment in lineedit.c!
                /* Returns:
                 * -1 on read errors or EOF, or on bare Ctrl-D.
                 * 0  on ctrl-C,

diff --git a/include/libbb.h b/include/libbb.h
index 25b2e448953b1d3559450b4fa81bb9caa762bc51..407b723b258487de06f98a072b702fe3588a1267 100644 (file)
--- 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);

diff --git a/libbb/lineedit.c b/libbb/lineedit.c
index 62f8949d61a8ccc758659f683e73e3123e548aa8..a018a53ff533246564e48efe47efed4f0d723f68 100644 (file)
--- a/libbb/lineedit.c
+++ b/libbb/lineedit.c
@@ -1253,6 +1253,11 @@ static void win_changed(int nsig)
 #undef CTRL
 #define CTRL(a) ((a) & ~0x40)
 
+/* Returns:
+ * -1 on read errors or EOF, or on bare Ctrl-D.
+ * 0  on ctrl-C,
+ * >0 length of input string, including terminating '\n'
+ */
 int read_line_input(const char* prompt, char* command, int maxsize, line_input_t *st)
 {
        int lastWasTab = FALSE;

diff --git a/libbb/skip_whitespace.c b/libbb/skip_whitespace.c
index bdfb97d70258a91ec7acd8f992ec9fbf1641e006..87b5f23ba1dc47c50c08b966f2921a8e64af48d7 100644 (file)
--- a/libbb/skip_whitespace.c
+++ b/libbb/skip_whitespace.c
@@ -11,7 +11,7 @@
 
 char *skip_whitespace(const char *s)
 {
-       /* NB: isspace('0') returns 0 */
+       /* NB: isspace('\0') returns 0 */
        while (isspace(*s)) ++s;
 
        return (char *) s;