OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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 <jakub.rzeszutko@nordicsemi.no>
This commit is contained in:
Jakub Rzeszutko 2018-10-02 11:59:27 +02:00 committed by Anas Nashif
parent c471614cb6
commit 794bda73dc
1 changed files with 1 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/subsystems/shell/shell.rst
View File

@ -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)
{