1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

Merge pull request #20485 from dylad/pr/treewide/remove_deprecated_shell_commands

treewide: remove deprecated shell_commands module
This commit is contained in:
Marian Buschsieweke 2024-03-26 08:39:26 +00:00 committed by GitHub
commit 1b64abf7dc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 9 additions and 21 deletions

View File

@ -4,12 +4,12 @@ This application is a showcase for RIOT's hardware support. Using it
for your board, you should be able to interactively use any hardware for your board, you should be able to interactively use any hardware
that is supported. that is supported.
To do this, the application uses the `shell` and `shell_commands` To do this, the application uses the `shell` and `shell_cmds_default`
modules and all the driver modules each board supports. modules and all the driver modules each board supports.
`shell` is a very simple interactive command interpreter that can be `shell` is a very simple interactive command interpreter that can be
used to call functions. Many of RIOT's modules define some generic used to call functions. Many of RIOT's modules define some generic
shell commands. These are included via the `shell_commands` module. shell commands. These are included via the `shell_cmds_default` module.
Additionally, the `ps` module which provides the `ps` shell command is Additionally, the `ps` module which provides the `ps` shell command is
included. included.

View File

@ -1,5 +1,4 @@
# Add deprecated modules here # Add deprecated modules here
# Keep this list ALPHABETICALLY SORTED!!!!111elven # Keep this list ALPHABETICALLY SORTED!!!!111elven
DEPRECATED_MODULES += sema_deprecated DEPRECATED_MODULES += sema_deprecated
DEPRECATED_MODULES += shell_commands # use shell_cmds_default instead
DEPRECATED_MODULES += ztimer_now64 DEPRECATED_MODULES += ztimer_now64

View File

@ -435,12 +435,6 @@ PSEUDOMODULES += shell_cmd_sys
PSEUDOMODULES += shell_cmd_udptty PSEUDOMODULES += shell_cmd_udptty
PSEUDOMODULES += shell_cmd_vfs PSEUDOMODULES += shell_cmd_vfs
PSEUDOMODULES += shell_cmds_default PSEUDOMODULES += shell_cmds_default
## @addtogroup sys_shell_commands
## @{
## @deprecated Use module `shell_cmds_default` instead;
## will be removed after 2023.07 release.
PSEUDOMODULES += shell_commands
## @}
PSEUDOMODULES += shell_hooks PSEUDOMODULES += shell_hooks
PSEUDOMODULES += shell_lock_auto_locking PSEUDOMODULES += shell_lock_auto_locking
PSEUDOMODULES += shield_w5100 PSEUDOMODULES += shield_w5100

View File

@ -70,7 +70,7 @@ endif
ifneq (,$(filter nimble_autoadv,$(USEMODULE))) ifneq (,$(filter nimble_autoadv,$(USEMODULE)))
USEMODULE += bluetil_ad USEMODULE += bluetil_ad
USEMODULE += bluetil_addr USEMODULE += bluetil_addr
ifneq (,$(filter shell_commands,$(USEMODULE))) ifneq (,$(filter shell_cmds_default,$(USEMODULE)))
DEFAULT_MODULE += nimble_autoadv_shell DEFAULT_MODULE += nimble_autoadv_shell
endif endif
endif endif

View File

@ -112,7 +112,7 @@ ifneq (,$(filter openwsn_sock_async,$(USEMODULE)))
USEMODULE += sock_async USEMODULE += sock_async
endif endif
ifneq (,$(filter shell_commands,$(USEMODULE))) ifneq (,$(filter shell_cmds_default,$(USEMODULE)))
USEMODULE += l2util USEMODULE += l2util
endif endif
# This port currently requires setting ISR_STACKSIZE # This port currently requires setting ISR_STACKSIZE

View File

@ -259,12 +259,6 @@ ifneq (,$(filter posix_sockets,$(USEMODULE)))
USEMODULE += posix_headers USEMODULE += posix_headers
endif endif
ifneq (,$(filter shell_commands,$(USEMODULE)))
# shell_commands has been renamed to shell_cmds_default, but let's keep this
# for backward compatibility
USEMODULE += shell_cmds_default
endif
ifneq (,$(filter shell_cmd%,$(USEMODULE))) ifneq (,$(filter shell_cmd%,$(USEMODULE)))
# each and every command is a submodule of shell_cmds # each and every command is a submodule of shell_cmds
USEMODULE += shell_cmds USEMODULE += shell_cmds

View File

@ -13,7 +13,8 @@
* @file * @file
* @brief A shell command to change the niceness (inverse priority) of a thread * @brief A shell command to change the niceness (inverse priority) of a thread
* *
* @note Enable this by using the modules shell_commands and nice * @note Enable this by using the modules shell_cmds_default and
* shell_cmd_nice
* *
* @author Marian Buschsieweke <marian.buschsieweke@ovgu.de> * @author Marian Buschsieweke <marian.buschsieweke@ovgu.de>
* *

View File

@ -15,11 +15,11 @@ Shell Commands
Certain modules such as `ps`, `saul_reg`, or `gnrc_icmpv6_echo` can expose Certain modules such as `ps`, `saul_reg`, or `gnrc_icmpv6_echo` can expose
(some of) their functionality not only as C-API, but also as shell command. (some of) their functionality not only as C-API, but also as shell command.
Using the module `shell_commands` will enable the shell integration of the used Using the module `shell_cmds_default` will enable the shell integration of the used
modules, if it exists. modules, if it exists.
A few rarely needed shell commands that needs to be used in addition to the A few rarely needed shell commands that needs to be used in addition to the
`shell_commands` and the module providing the C-API. Examples include `shell_cmds_default` and the module providing the C-API. Examples include
`shell_cmd_nice`, `shell_cmd_gnrc_udp`, or `shell_random_cmd`. `shell_cmd_nice`, `shell_cmd_gnrc_udp`, or `shell_random_cmd`.
Consult the documentation of the modules to find out whether they have a Consult the documentation of the modules to find out whether they have a
shell integration and how to enable it. shell integration and how to enable it.

View File

@ -1,7 +1,7 @@
This application shows how to use own or the system shell commands. In order to use This application shows how to use own or the system shell commands. In order to use
the system shell commands: the system shell commands:
1. Additionally to the module: shell, shell_commands, 1. Additionally to the module: shell, shell_cmds_default,
the module for the corresponding system command is to include, e.g. the module for the corresponding system command is to include, e.g.
module ps for the ps command (cf. the Makefile in the application root module ps for the ps command (cf. the Makefile in the application root
directory). directory).