espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-30 18:57:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Enable the component manager by default in CMake

Browse Source
This commit is contained in:
Sergei Silnov
2022-04-08 17:58:05 +02:00
committed by Fu Hanxi
parent 5d1864b7d7
commit fdc70f5b7f
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/en/api-guides/tools/idf-component-manager.rst
View File

@ -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 `<https://components.espressif.com/>`_ A list of components can be found on `<https://components.espressif.com/>`_
Activating the Component Manager
================================
If CMake is started using ``idf.py`` or `ESP-IDF VSCode Extension <https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-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 Using with a project
==================== ====================
@ -70,3 +63,8 @@ Defining dependencies in the manifest
# # with relative or absolute path # # with relative or absolute path
# some_local_component: # some_local_component:
# path: ../../projects/component # path: ../../projects/component
Disabling the Component Manager
===============================
The component manager can be explicitly disabled by setting ``IDF_COMPONENT_MANAGER`` environment variable to ``0``.