Code clean up

[z180-stamp.git] / include / cli_readline.h

diff --git a/include/cli_readline.h b/include/cli_readline.h
index 0ce28a5532e8be3a7baa8fda9ea474d5fac117e2..f326106d4c5e035d61c27501aaad6fd6c02d00aa 100644 (file)
--- a/include/cli_readline.h
+++ b/include/cli_readline.h
@@ -18,38 +18,17 @@ extern char console_buffer[];       /* console I/O buffer   */
 /**
  * cli_readline() - read a line into the console_buffer
  *
- * This is a convenience function which calls cli_readline_into_buffer().
- *
- * @prompt: Prompt to display
- * @enable_history: Use history buffer if true
- * @return command line length excluding terminator, or -ve on error
- */
-int cli_readline(const FLASH char *const prompt, bool enable_history);
-
-/**
- * readline_into_buffer() - read a line into a buffer
- *
- * Display the prompt, then read a command line into @buffer. The
+ * Display the prompt, then read a command line into console_buffer. The
  * maximum line length is CONFIG_SYS_CBSIZE including a \0 terminator, which
  * will always be added.
  *
  * The command is echoed as it is typed. Command editing is supported.
  * Tab auto-complete is supported if CONFIG_AUTO_COMPLETE is defined.
- * If CONFIG_BOOT_RETRY_TIME is defined, then a timeout will be applied.
- *
- * If CONFIG_BOOT_RETRY_TIME is defined and retry_time >= 0,
- * time out when time goes past endtime (timebase time in ticks).
  *
- * @prompt:    Prompt to display
- * @buffer:    Place to put the line that is entered
- * @timeout:   Timeout in milliseconds, 0 if none
- * @return command line length excluding terminator, or -ve on error: of the
- * timeout is exceeded (either CONFIG_BOOT_RETRY_TIME or the timeout
- * parameter), then -2 is returned. If a break is detected (Ctrl-C) then
- * -1 is returned.
+ * @prompt: Prompt to display
+ * @enable_history: Use history buffer if true
+ * @return command line length excluding terminator, or -ve on error
  */
-//int cli_readline_into_buffer(const char *const prompt, char *buffer,
-//                     int timeout, bool enable_history);
-
+int cli_readline(const FLASH char *const prompt, bool enable_history);
 
 #endif /* CLI_READLINE_H */