shell: move shell to its own subsystem

This moves the shell component into its own subsys and groups all
related files and options into a single place.

Additionally, one Kconfig option will now be required to enable the
shell:

 CONFIG_CONSOLE_SHELL=y

The header files was also moved to include/shell/shell.h and can be now
referenced with

 #include <shell/shell.h>

instead of

 #include <misc/shell.h>

Updated documentation as well.

Change-Id: Iffbba4acfa05408055e9fd28dffa213451351f94
Signed-off-by: Anas Nashif <[email protected]>

Author: nashif

doc/subsystems/shell.rst

@@ -6,11 +6,11 @@ Shell
 Overview
 ********
 
-Zephyr OS Shell enables multiple Zephyr OS modules to use and expose their
-shell interface simultaneously.
+The Shell enables multiple subsystem to use and expose their shell interface
+simultaneously.
 
-Each module can support shell functionality dynamically by its Kconfig file,
-which enables or disables the shell usage for the module.
+Each subbsystem can support shell functionality dynamically by its Kconfig file,
+which enables or disables the shell usage for the subsystem.
 
 Using shell commands
 ********************
@@ -19,14 +19,19 @@ Use one of the following formats:
 
 Specific module's commands
 ==========================
+
+A shell interface exposing subsystem features is a shell module, multiple
+modules can be available at the same time.
+
 `MODULE_NAME COMMAND`
  One of the available modules is “KERNEL”, for the Kernel module.  More
  information can be found in :c:macro:`SHELL_REGISTER`.
 
 Help commands
 =============
+
 `help`
- Prints the available modules.
+ Prints the list of available modules.
 
 `help MODULE_NAME`
  Prints the names of the available commands for the module.
@@ -37,6 +42,7 @@ Help commands
 
 Select module commands
 ======================
+
 `set_module MODULE_NAME`
  Use this command when using the shell only for one module. After entering this
  command, you will not need to enter module name in further commands. If
@@ -54,40 +60,33 @@ There are two levels of configuration: Infrastructure level and Module level.
 Infrastructure level
 ====================
 
-The default value for ENABLE_SHELL flag should be considered per product.
-This flag enables shell services.
+The option :option:`CONFIG_CONSOLE_SHELL` enables the shell subsystem and enable the
+default features of the shell subsystem.
 
-If it is enabled, kernel shell commands are also available for use.
-See the :option:`CONFIG_ENABLE_SHELL` Kconfig options for more information.
-
-Module level
-============
-Each module using shell service should add a unique flag in its Kconfig file.
+Module/Subsystem level
+======================
+Each subsystem using the shell service should add a unique flag in its Kconfig file.
 
 Example:
 
-CONFIG_SAMPLE_MODULE_USE_SHELL=y
-
-In the module’s code, the shell usage depends on this config parameter.
-This module-specific flag should also depend on ENABLE_SHELL flag.
+CONFIG_NET_SHELL=y
 
-Therefore, there is one global flag, in addition to a unique flag per each
-module.
-The default value for ENABLE_SHELL flag should be considered per product.
+In the subsystem’s code, the shell usage depends on this config parameter.
+This subsystem specific flag should also depend on :option:`CONFIG_CONSOLE_SHELL` flag.
 
 Configuration steps to add shell functionality to a module
 ==========================================================
 
- #. Check that ENABLE_SHELL is set to yes.
- #. Add the module unique flag to its Kconfig file.
+ #. Check that :option:`CONFIG_CONSOLE_SHELL` is set to yes.
+ #. Add the subsystem unique flag to its Kconfig file.
 
 Writing a shell module
 **********************
 
-In order to support shell in your module, the application must do the following:
+In order to support shell in your subsystem, the application must do the following:
 
-#. Module configuration flag: Declare a new flag in your module Kconfig file.
-   It should depend on `ENABLE_SHELL` flag.
+#. Module configuration flag: Declare a new flag in your subsystem Kconfig file.
+   It should depend on `:option:`CONFIG_CONSOLE_SHELL`` flag.
 
 #. Module registration to shell: Add your shell identifier and register its
    callback functions in the shell database using :c:macro:`SHELL_REGISTER`.

drivers/console/Kconfig

@@ -39,22 +39,6 @@ config CONSOLE_HANDLER
 	This option enables console input handler allowing to write simple
 	interaction between serial console and the OS.
 
-config CONSOLE_HANDLER_SHELL
-	bool
-	prompt "Enable console input handler [ Experimental ]"
-	default n
-	depends on CONSOLE_HANDLER
-	help
-	Shell implementation based on CONSOLE_HANDLER.
-
-config CONSOLE_HANDLER_SHELL_STACKSIZE
-	int
-	prompt "Console handler shell stack size"
-	default 2000
-	depends on CONSOLE_HANDLER_SHELL
-	help
-	Stack size for the console handler shell.
-
 config UART_CONSOLE
 	bool
 	prompt "Use UART for console"

drivers/console/Makefile

@@ -1,5 +1,3 @@
-obj-$(CONFIG_ENABLE_SHELL) += shells/
-obj-$(CONFIG_CONSOLE_HANDLER_SHELL) += console_handler_shell.o
 obj-$(CONFIG_UART_CONSOLE) += uart_console.o
 obj-$(CONFIG_RAM_CONSOLE) += ram_console.o
 obj-$(CONFIG_RTT_CONSOLE) += rtt_console.o

drivers/console/shells/Kconfig

@@ -64,7 +64,7 @@ struct shell_module {
  * @param shell_commands Array of commands to register.
  * Shell array entries must be packed to calculate array size correctly.
  */
-#ifdef CONFIG_ENABLE_SHELL
+#ifdef CONFIG_CONSOLE_SHELL
 #define SHELL_REGISTER(shell_name, shell_commands) \
 	\
 	static struct shell_module (__shell_shell_name) __used \
@@ -115,7 +115,7 @@ void shell_register_default_module(const char *name);
 */
 
 
-#ifdef CONFIG_ENABLE_SHELL
+#ifdef CONFIG_CONSOLE_SHELL
 int shell_run(struct device *dev);
 #else
 static inline int shell_run(struct device *dev)

include/misc/shell.h renamed to include/shell/shell.h

@@ -230,7 +230,6 @@ For that purpose, following flags must be enabled in project configuration file
 <-- snippet
 CONFIG_KERNEL_EVENT_LOGGER_DYNAMIC=y
 CONFIG_CONSOLE_HANDLER=y
-CONFIG_CONSOLE_HANDLER_SHELL=y
 -->
 
 command implementation.

samples/legacy/task_profiler/README.txt

@@ -1,7 +1,6 @@
 CONFIG_STDOUT_CONSOLE=y
 CONFIG_CONSOLE_HANDLER=y
-CONFIG_CONSOLE_HANDLER_SHELL=y
-CONFIG_ENABLE_SHELL=y
+CONFIG_CONSOLE_SHELL=y
 CONFIG_TASK_MONITOR=y
 CONFIG_TASK_MONITOR_MASK=6
 CONFIG_RING_BUFFER=y

samples/legacy/task_profiler/microkernel/prj.conf

@@ -1,7 +1,6 @@
 CONFIG_STDOUT_CONSOLE=y
 CONFIG_CONSOLE_HANDLER=y
-CONFIG_CONSOLE_HANDLER_SHELL=y
-CONFIG_ENABLE_SHELL=y
+CONFIG_CONSOLE_SHELL=y
 CONFIG_TASK_MONITOR=y
 CONFIG_TASK_MONITOR_MASK=6
 CONFIG_RING_BUFFER=y

samples/legacy/task_profiler/microkernel/prj_quark_se_c1000_devboard.conf

@@ -1,7 +1,6 @@
 CONFIG_STDOUT_CONSOLE=y
 CONFIG_CONSOLE_HANDLER=y
-CONFIG_CONSOLE_HANDLER_SHELL=y
-CONFIG_ENABLE_SHELL=y
+CONFIG_CONSOLE_SHELL=y
 CONFIG_RING_BUFFER=y
 CONFIG_KERNEL_EVENT_LOGGER=y
 CONFIG_KERNEL_EVENT_LOGGER_DYNAMIC=y

samples/legacy/task_profiler/nanokernel/prj.conf

@@ -1,7 +1,6 @@
 CONFIG_STDOUT_CONSOLE=y
 CONFIG_CONSOLE_HANDLER=y
-CONFIG_CONSOLE_HANDLER_SHELL=y
-CONFIG_ENABLE_SHELL=y
+CONFIG_CONSOLE_SHELL=y
 CONFIG_RING_BUFFER=y
 CONFIG_KERNEL_EVENT_LOGGER=y
 CONFIG_KERNEL_EVENT_LOGGER_DYNAMIC=y