9ab0ea73a8
In order to enable better and more consistent help messages for shell commands, this commit introduces a new SHELL_HELP macro that allows to document a command's description and usage in a more structured way. This will allow to get rid of inconsistent (and duplicated!) variations of "Syntax: ...", "Syntax:\n ...", "Usage: ...", in the commands, and formatting of the description+usage will be taken care of by the shell when it detects the help message is using the "structured" format. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org> |
||
|---|---|---|
| .. | ||
| backends | ||
| modules | ||
| CMakeLists.txt | ||
| Kconfig | ||
| Kconfig.template.shell_log_queue_size | ||
| Kconfig.template.shell_log_queue_timeout | ||
| shell_cmds.c | ||
| shell_fprintf.c | ||
| shell_help.c | ||
| shell_help.h | ||
| shell_history.c | ||
| shell_log_backend.c | ||
| shell_ops.c | ||
| shell_ops.h | ||
| shell_utils.c | ||
| shell_utils.h | ||
| shell_vt100.h | ||
| shell_wildcard.c | ||
| shell_wildcard.h | ||
| shell.c | ||