michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: header file update

Browse source 
Minor formatting corrections in shell.h file.

Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
This commit is contained in:
Jakub Rzeszutko 2018-12-06 14:53:23 +01:00 • committed by Carles Cufí
commit 0c678fac9d
1 changed files with 88 additions and 88 deletions
Download patch file Download diff file Expand all files Collapse all files

12
include/shell/shell.h
View file

@ -135,7 +135,7 @@ struct shell_static_entry {
* @brief Macro for defining and adding a root command (level 0) with * @brief Macro for defining and adding a root command (level 0) with
* arguments. * arguments.
* *
* @note Each root command shall have unique syntax. * @note All root commands must have different name.
* *
* @param[in] syntax Command syntax (for example: history). * @param[in] syntax Command syntax (for example: history).
* @param[in] subcmd Pointer to a subcommands array. * @param[in] subcmd Pointer to a subcommands array.
@ -205,7 +205,7 @@ struct shell_static_entry {
.help = (const char *)_help, \ .help = (const char *)_help, \
.handler = _handler, \ .handler = _handler, \
.args = _mandatory ? \ .args = _mandatory ? \
(&(struct shell_static_args) SHELL_ARG(_mandatory, _optional)) : NULL\ (&(struct shell_static_args) SHELL_ARG(_mandatory, _optional)) : NULL \
} }
/** /**
@ -389,7 +389,7 @@ struct shell_ctx {
/*!< VT100 color and cursor position, terminal width.*/ /*!< VT100 color and cursor position, terminal width.*/
struct shell_vt100_ctx vt100_ctx; struct shell_vt100_ctx vt100_ctx;
u16_t cmd_buff_len;/*!< Command length.*/ u16_t cmd_buff_len; /*!< Command length.*/
u16_t cmd_buff_pos; /*!< Command buffer cursor position.*/ u16_t cmd_buff_pos; /*!< Command buffer cursor position.*/
u16_t cmd_tmp_buff_len; /*!< Command length in tmp buffer.*/ u16_t cmd_tmp_buff_len; /*!< Command length in tmp buffer.*/
@ -470,7 +470,7 @@ extern void shell_print_stream(const void *user_ctx, const char *data,
true, shell_print_stream); \ true, shell_print_stream); \
LOG_INSTANCE_REGISTER(shell, _name, CONFIG_SHELL_LOG_LEVEL); \ LOG_INSTANCE_REGISTER(shell, _name, CONFIG_SHELL_LOG_LEVEL); \
SHELL_STATS_DEFINE(_name); \ SHELL_STATS_DEFINE(_name); \
static K_THREAD_STACK_DEFINE(_name##_stack, CONFIG_SHELL_STACK_SIZE);\ static K_THREAD_STACK_DEFINE(_name##_stack, CONFIG_SHELL_STACK_SIZE); \
static struct k_thread _name##_thread; \ static struct k_thread _name##_thread; \
static const struct shell _name = { \ static const struct shell _name = { \
.prompt = _name##prompt, \ .prompt = _name##prompt, \
@ -555,11 +555,11 @@ int shell_stop(const struct shell *shell);
#define SHELL_ERROR SHELL_VT100_COLOR_RED #define SHELL_ERROR SHELL_VT100_COLOR_RED
/** /**
* @brief Printf-like function which sends formatted data stream to the shell. * @brief printf-like function which sends formatted data stream to the shell.
* This function shall not be used outside of the shell command context. * This function shall not be used outside of the shell command context.
* *
* @param[in] shell Pointer to the shell instance. * @param[in] shell Pointer to the shell instance.
* @param[in] color Printf color. * @param[in] color Printed text color.
* @param[in] p_fmt Format string. * @param[in] p_fmt Format string.
* @param[in] ... List of parameters to print. * @param[in] ... List of parameters to print.
*/ */