patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity
zephyr/subsys/shell/Kconfig

122 lines
2.7 KiB
Plaintext
Raw Normal View History

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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
# Kconfig - Shell configuration options
#
# Copyright (c) 2014-2015 Wind River Systems, Inc.
# Copyright (c) 2016 Intel Corporation
#
license: Replace Apache boilerplate with SPDX tag Replace the existing Apache 2.0 boilerplate header with an SPDX tag throughout the zephyr code tree. This patch was generated via a script run over the master branch. Also updated doc/porting/application.rst that had a dependency on line numbers in a literal include. Manually updated subsys/logging/sys_log.c that had a malformed header in the original file. Also cleanup several cases that already had a SPDX tag and we either got a duplicate or missed updating. Jira: ZEP-1457 Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-01-19 02:01:01 +01:00
# SPDX-License-Identifier: Apache-2.0
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
#
config CONSOLE_SHELL
subsys: kconfig: Remove 'default n' properties and clean up a bit Bool symbols implicitly default to 'n'. A 'default n' can make sense e.g. in a Kconfig.defconfig file, if you want to override a 'default y' on the base definition of the symbol. It isn't used like that on any of these symbols though. Remove some 'default ""' properties on string symbols too. Also make definitions more consistent by converting some config FOO <type> prompt "foo" definitions to a shorter form: config FOO <type> "foo" This shorthand works for int/hex/string symbols too, not just for bool symbols. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-07-12 13:26:29 +02:00
bool "Enable console input handler [ Experimental ]"
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
select CONSOLE_HANDLER
subsys: console: Factor out fifo-based console input abstraction Console subsystem is intended to be a layer between console drivers and console clients, like e.g. shell. This change factors out code from shell which dealed with individial console drivers and moves it to console subsystem, under the name console_register_line_input(). To accommodate for this change, older console subsys Kconfig symbol is changed from CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS (CONFIG_CONSOLE is already used by console drivers). This signifies that console subsystem is intended to deal with all of console aspects in Zephyr (existing and new), not just provide some "new" functionality on top of raw console drivers, like it initially started. Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
2018-06-07 21:30:21 +02:00
select CONSOLE_SUBSYS
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
help
kconfig: fix help syntax and add spaces Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-12-13 16:08:21 +01:00
Shell implementation based on CONSOLE_HANDLER.
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
if CONSOLE_SHELL
shell: Make the command queue size configurable via Kconfig Change-Id: I80551c76903118bfe831776c87135e89d32552da Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2017-01-24 10:18:26 +01:00
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
config CONSOLE_SHELL_STACKSIZE
subsys: kconfig: Remove 'default n' properties and clean up a bit Bool symbols implicitly default to 'n'. A 'default n' can make sense e.g. in a Kconfig.defconfig file, if you want to override a 'default y' on the base definition of the symbol. It isn't used like that on any of these symbols though. Remove some 'default ""' properties on string symbols too. Also make definitions more consistent by converting some config FOO <type> prompt "foo" definitions to a shorter form: config FOO <type> "foo" This shorthand works for int/hex/string symbols too, not just for bool symbols. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-07-12 13:26:29 +02:00
int "Console handler shell stack size"
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
default 2000
help
kconfig: fix help syntax and add spaces Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-12-13 16:08:21 +01:00
Stack size for the console handler shell.
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
shell: Make the command queue size configurable via Kconfig Change-Id: I80551c76903118bfe831776c87135e89d32552da Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2017-01-24 10:18:26 +01:00
config CONSOLE_SHELL_MAX_CMD_QUEUED
int "Shell's command queue size"
default 3
help
kconfig: fix help syntax and add spaces Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-12-13 16:08:21 +01:00
Maximum size of the queue for input commands.
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 <anas.nashif@intel.com>
2016-12-23 20:06:46 +01:00
source "subsys/shell/modules/Kconfig"
endif
shell: Shell subsystem reimplementation New shell support features like: - multi-instance - command tree - static and dynamic commands - multiline - help print function - smart tab (autocompletion) - meta-keys - history, wildcards etc. - generic transport (initially, uart present) Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no> Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no> Signed-off-by: Piotr Zięcik <piotr.ziecik@nordicsemi.no>
2018-08-09 09:56:10 +02:00
config SHELL
bool "Enable shell"
select LOG_RUNTIME_FILTERING
select POLL
if SHELL
module = SHELL
module-str = Shell
source "subsys/logging/Kconfig.template.log_config"
config SHELL_STACK_SIZE
int "Shell thread stack size"
default 1024 if MULTITHREADING
default 0 if !MULTITHREADING
help
Stack size for thread created for each instance.
config SHELL_THREAD_PRIO
int "Shell thread priority"
depends on MULTITHREADING
default -2
help
Shell thread priority.
config SHELL_BACKSPACE_MODE_DELETE
bool "Default escape code for backspace is DELETE (0x7F)"
default y
help
Terminals have different escape code settings for backspace button.
Some terminals send code: 0x08 (backspace) other 0x7F (delete). When
this option is set shell will expect 0x7F for backspace key.
config SHELL_CMD_BUFF_SIZE
int "Shell command buffer size"
default 256
help
Maximum command size.
config SHELL_PRINTF_BUFF_SIZE
int "Shell print buffer size"
default 30
help
Maximum text buffer size for fprintf function.
It is working like stdio buffering in Linux systems
to limit number of peripheral access calls.
config SHELL_ARGC_MAX
int "Maximum arguments in shell command"
default 12
help
Maximum number of arguments that can build a command.
If command is composed of more than defined, argument SHELL_ARGC_MAX
and following are passed as one argument in the string.
config SHELL_ECHO_STATUS
bool "Enable echo on shell"
default y
help
If enabled shell prints back every input byte.
config SHELL_VT100_COLORS
bool "Enable colors in shell"
default y
help
If enabled VT100 colors are used in shell (e.g. print errors in red).
config SHELL_METAKEYS
bool "Enable metakeys"
default y
help
Enables shell metakeys: Home, End, ctrl+a, ctrl+c, ctrl+e, ctrl+l,
ctrl+u, ctrl+w
config SHELL_HELP
bool "Enable help message"
default y
help
Enables formatting help message when requested with '-h' or '--help'.
config SHELL_HELP_ON_WRONG_ARGUMENT_COUNT
bool "Enable printing help on wrong argument count"
default y
endif #SHELL
Reference in a new issue Copy permalink