michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Shell: Remove reference to alphabetically sorted

Browse source 
It is no longer required to have the command table alphabetically
sorted.

Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This commit is contained in:
Luiz Augusto von Dentz 2018-10-03 10:21:54 +03:00 • committed by Carles Cufí
commit bbaa374afa
2 changed files with 1 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/subsystems/shell/shell.rst
View file

@ -56,13 +56,10 @@ Use the following macros for adding shell commands:
have different name. have different name.
* :c:macro:`SHELL_CMD` - Initialize a command. * :c:macro:`SHELL_CMD` - Initialize a command.
* :c:macro:`SHELL_CREATE_STATIC_SUBCMD_SET` - Create a static subcommands * :c:macro:`SHELL_CREATE_STATIC_SUBCMD_SET` - Create a static subcommands
array. Static subcommands must be added in alphabetical order to ensure array.
correct smart completion.
* :c:macro:`SHELL_SUBCMD_SET_END` - shall be placed as last in * :c:macro:`SHELL_SUBCMD_SET_END` - shall be placed as last in
:c:macro:`SHELL_CREATE_STATIC_SUBCMD_SET` macro. :c:macro:`SHELL_CREATE_STATIC_SUBCMD_SET` macro.
* :c:macro:`SHELL_CREATE_DYNAMIC_CMD` - Create a dynamic subcommands array. * :c:macro:`SHELL_CREATE_DYNAMIC_CMD` - Create a dynamic subcommands array.
Dynamic subcommands must be returned in alphabetical order to ensure correct
smart completion.
Commands can be created in any file in the system that includes Commands can be created in any file in the system that includes
:file:`include/shell/shell.h`. All created commands are available for all :file:`include/shell/shell.h`. All created commands are available for all
@ -86,7 +83,6 @@ subcommands.
*/ */
SHELL_CREATE_STATIC_SUBCMD_SET(sub_demo) SHELL_CREATE_STATIC_SUBCMD_SET(sub_demo)
{ {
/* Alphabetically sorted. */
SHELL_CMD(params, NULL, "Print params command.", SHELL_CMD(params, NULL, "Print params command.",
cmd_demo_params), cmd_demo_params),
SHELL_CMD(ping, NULL, "Ping command.", cmd_demo_ping), SHELL_CMD(ping, NULL, "Ping command.", cmd_demo_ping),
@ -130,9 +126,6 @@ Newly added commands can be prompted or autocompleted with the :kbd:`Tab` key.
struct shell_static_entry *entry) struct shell_static_entry *entry)
{ {
if (idx < dynamic_cmd_cnt) { if (idx < dynamic_cmd_cnt) {
/* m_dynamic_cmd_buffer must be sorted alphabetically
* to ensure correct Shell autocompletion
*/
entry->syntax = dynamic_cmd_buffer[idx]; entry->syntax = dynamic_cmd_buffer[idx];
entry->handler = NULL; entry->handler = NULL;
entry->subcmd = NULL; entry->subcmd = NULL;
@ -469,7 +462,6 @@ The following code shows a simple use case of this library:
*/ */
SHELL_CREATE_STATIC_SUBCMD_SET(sub_demo) SHELL_CREATE_STATIC_SUBCMD_SET(sub_demo)
{ {
/* Alphabetically sorted. */
SHELL_CMD(params, NULL, "Print params command.", SHELL_CMD(params, NULL, "Print params command.",
cmd_demo_params), cmd_demo_params),
SHELL_CMD(ping, NULL, "Ping command.", cmd_demo_ping), SHELL_CMD(ping, NULL, "Ping command.", cmd_demo_ping),

4
subsys/shell/shell_cmds.c
View file

@ -446,10 +446,6 @@ static int cmd_resize(const struct shell *shell, size_t argc, char **argv)
return 0; return 0;
} }
/* Warning!
* Subcommands must be placed in alphabetical order to ensure correct
* autocompletion.
*/
SHELL_CREATE_STATIC_SUBCMD_SET(m_sub_colors) SHELL_CREATE_STATIC_SUBCMD_SET(m_sub_colors)
{ {
SHELL_CMD(off, NULL, SHELL_HELP_COLORS_OFF, cmd_colors_off), SHELL_CMD(off, NULL, SHELL_HELP_COLORS_OFF, cmd_colors_off),