From fdc70f5b7fd0df758081d0e0cba921caf654393d Mon Sep 17 00:00:00 2001 From: Sergei Silnov Date: Fri, 8 Apr 2022 17:58:05 +0200 Subject: [PATCH] docs: Enable the component manager by default in CMake --- docs/en/api-guides/tools/idf-component-manager.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/en/api-guides/tools/idf-component-manager.rst b/docs/en/api-guides/tools/idf-component-manager.rst index 3700256194..fcd268c380 100644 --- a/docs/en/api-guides/tools/idf-component-manager.rst +++ b/docs/en/api-guides/tools/idf-component-manager.rst @@ -6,13 +6,6 @@ The IDF Component manager is a tool that downloads dependencies for any ESP-IDF A list of components can be found on ``_ -Activating the Component Manager -================================ - -If CMake is started using ``idf.py`` or `ESP-IDF VSCode Extension `_ then the component manager will be activated by default. - -If CMake is used directly or with some CMake-based IDE like CLion, it's necessary to set the ``IDF_COMPONENT_MANAGER`` environment variable to ``1`` to enable the component manager integration with the build system. - Using with a project ==================== @@ -70,3 +63,8 @@ Defining dependencies in the manifest # # with relative or absolute path # some_local_component: # path: ../../projects/component + +Disabling the Component Manager +=============================== + +The component manager can be explicitly disabled by setting ``IDF_COMPONENT_MANAGER`` environment variable to ``0``.