From 749eb6a0279669ead8170bf6c0542a412f71f541 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Mon, 30 Sep 2013 17:43:44 -0600 Subject: [PATCH] cosmetic update to comments --- include/readline.h | 11 ++++++----- system/readline/std_readline.c | 8 +++----- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/include/readline.h b/include/readline.h index 463643534..a9c322b8c 100644 --- a/include/readline.h +++ b/include/readline.h @@ -98,11 +98,14 @@ ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream); /**************************************************************************** * Name: std_readline * - * std_readline is requivalent to readline except that it uses only stdin - * and stdout. + * readline() reads in at most one less than 'buflen' characters from + * 'stdin' and stores them into the buffer pointed to by 'buf'. + * Characters are echoed on 'stdout'. Reading stops after an EOF or a + * newline. If a newline is read, it is stored into the buffer. A null + * terminator is stored after the last character in the buffer. * * This version of realine assumes that we are reading and writing to - * a VT100 console. This will not work well if 'instream' or 'outstream' + * a VT100 console. This will not work well if 'stdin' or 'stdout' * corresponds to a raw byte steam. * * This function is inspired by the GNU readline but is an entirely @@ -111,8 +114,6 @@ ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstream); * Input Parameters: * buf - The user allocated buffer to be filled. * buflen - the size of the buffer. - * instream - The stream to read characters from - * outstream - The stream to each characters to. * * Returned values: * On success, the (positive) number of bytes transferred is returned. diff --git a/system/readline/std_readline.c b/system/readline/std_readline.c index 8778f1677..5f44fcf43 100644 --- a/system/readline/std_readline.c +++ b/system/readline/std_readline.c @@ -126,13 +126,13 @@ static void readline_write(FAR struct rl_common_s *vtbl, * Name: std_readline * * readline() reads in at most one less than 'buflen' characters from - * 'instream' and stores them into the buffer pointed to by 'buf'. - * Characters are echoed on 'outstream'. Reading stops after an EOF or a + * 'stdin' and stores them into the buffer pointed to by 'buf'. + * Characters are echoed on 'stdout'. Reading stops after an EOF or a * newline. If a newline is read, it is stored into the buffer. A null * terminator is stored after the last character in the buffer. * * This version of realine assumes that we are reading and writing to - * a VT100 console. This will not work well if 'instream' or 'outstream' + * a VT100 console. This will not work well if 'stdin' or 'stdout' * corresponds to a raw byte steam. * * This function is inspired by the GNU readline but is an entirely @@ -141,8 +141,6 @@ static void readline_write(FAR struct rl_common_s *vtbl, * Input Parameters: * buf - The user allocated buffer to be filled. * buflen - the size of the buffer. - * instream - The stream to read characters from - * outstream - The stream to each characters to. * * Returned values: * On success, the (positive) number of bytes transferred is returned.