From 6dd55e904dc8ef36e387efffebd8b3c66d12e439 Mon Sep 17 00:00:00 2001 From: Abhik Roy <107937815+espressif-abhikroy@users.noreply.github.com> Date: Wed, 25 Oct 2023 12:11:44 +0200 Subject: [PATCH] Update components/console_simple_init/README.md Co-authored-by: Ivan Grokhotkov --- components/console_simple_init/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/components/console_simple_init/README.md b/components/console_simple_init/README.md index 4f5cb4b3ce1..9093b485806 100644 --- a/components/console_simple_init/README.md +++ b/components/console_simple_init/README.md @@ -39,6 +39,10 @@ It also provides an api to register an user provided command. ``` ### Automatic registration of console commands -To add a plugin command or any component from IDF component manager into your project, simply include an entry within the `idf_component.yml` file. +`console_simple_init` component provides a function `console_cmd_all_register` which performs automatic registration of all commands linked into the application. + +In order for the command to be registered automatically, it has to place the registration function into console_simple_init_desc section. + + For more details refer [IDF Component Manager](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-component-manager.html)