From 794bda73dc32e24eefe2a746a34c35012e7fd5da Mon Sep 17 00:00:00 2001 From: Jakub Rzeszutko Date: Tue, 2 Oct 2018 11:59:27 +0200 Subject: [PATCH] doc: shell: update documentation to reflect bug fix #10207 Shell macro SHELL_DEFINE no longer needs new line character. Specification has been updated accordingly. Signed-off-by: Jakub Rzeszutko --- doc/subsystems/shell/shell.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/doc/subsystems/shell/shell.rst b/doc/subsystems/shell/shell.rst index b15ce53b2c0..1ad6b8de3d9 100644 --- a/doc/subsystems/shell/shell.rst +++ b/doc/subsystems/shell/shell.rst @@ -425,8 +425,6 @@ Usage ***** Use the :c:macro:`SHELL_DEFINE` macro to create an instance of the shell. -Pass the expected newline character to this macro: either ``\r`` or ``\n``, -otherwise the shell will not respond correctly to the :kbd:`Enter` key. The following code shows a simple use case of this library: @@ -436,7 +434,7 @@ The following code shows a simple use case of this library: SHELL_UART_DEFINE(shell_transport_uart); /* Creating shell instance */ - SHELL_DEFINE(uart_shell, "uart:~$ ", &shell_transport_uart, '\r', 10); + SHELL_DEFINE(uart_shell, "uart:~$ ", &shell_transport_uart, 10); void main(void) {