From f78a41f1b343f0adcbfaf0a3fecb0b894c2de0c6 Mon Sep 17 00:00:00 2001 From: Dylan Laduranty Date: Tue, 19 Mar 2024 15:12:02 +0100 Subject: [PATCH] treewide: replace shell_commands module in documentation Signed-off-by: Dylan Laduranty --- examples/default/README.md | 4 ++-- sys/shell/cmds/nice.c | 3 ++- sys/shell/doc.txt | 4 ++-- tests/sys/shell/ReadMe.txt | 2 +- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/examples/default/README.md b/examples/default/README.md index 42bbb5f143..e1fa440c51 100644 --- a/examples/default/README.md +++ b/examples/default/README.md @@ -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 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. `shell` is a very simple interactive command interpreter that can be 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 included. diff --git a/sys/shell/cmds/nice.c b/sys/shell/cmds/nice.c index 1b6925288d..87c41c65a6 100644 --- a/sys/shell/cmds/nice.c +++ b/sys/shell/cmds/nice.c @@ -13,7 +13,8 @@ * @file * @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 * diff --git a/sys/shell/doc.txt b/sys/shell/doc.txt index f6027b8459..832486f389 100644 --- a/sys/shell/doc.txt +++ b/sys/shell/doc.txt @@ -15,11 +15,11 @@ Shell Commands 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. -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. 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`. Consult the documentation of the modules to find out whether they have a shell integration and how to enable it. diff --git a/tests/sys/shell/ReadMe.txt b/tests/sys/shell/ReadMe.txt index 16bf30e241..d377310914 100644 --- a/tests/sys/shell/ReadMe.txt +++ b/tests/sys/shell/ReadMe.txt @@ -1,7 +1,7 @@ This application shows how to use own or the system shell commands. In order to use 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. module ps for the ps command (cf. the Makefile in the application root directory).