mirror of
https://github.com/espressif/esp-idf.git
synced 2026-09-26 22:00:39 +03:00
f8adfd176e
Split the single build-system-v2 page into a landing page that dispatches to focused how-to guides (creating a project, creating components, configuring dependencies, third-party libraries, ESP-IDF as a library, multiple binaries) and reference pages (design and architecture, breaking changes, and the generated API reference). Mirror the new structure on zh_CN and update the API Guides table of contents. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
57 lines
1.7 KiB
ReStructuredText
57 lines
1.7 KiB
ReStructuredText
API Reference
|
|
*************
|
|
|
|
This page is an automatically generated reference for the public API of Build System v2, extracted from the CMake source in ``tools/cmakev2``. For how these are used in practice, see the guides on the :doc:`Build System v2 <index>` page.
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 1
|
|
|
|
.. _cmakev2_functions:
|
|
|
|
Functions
|
|
=========
|
|
|
|
|
|
.. _cmakev2_macros:
|
|
|
|
Macros
|
|
======
|
|
|
|
|
|
.. _cmakev2_variables:
|
|
|
|
Variables
|
|
=========
|
|
|
|
|
|
.. _cmakev2_build_properties:
|
|
|
|
Build Properties
|
|
================
|
|
|
|
Build properties are global to the project and are read and written with :cmakev2:ref:`idf_build_get_property` and :cmakev2:ref:`idf_build_set_property`.
|
|
|
|
|
|
.. _cmakev2_component_properties:
|
|
|
|
Component Properties
|
|
====================
|
|
|
|
Component properties are attached to a single component and are read and written with :cmakev2:ref:`idf_component_get_property` and :cmakev2:ref:`idf_component_set_property`.
|
|
|
|
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/build.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/compat.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/component.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/dfu.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/idf.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/kconfig.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/ldgen.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/manager.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/project.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/size.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/uf2.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/utilities.cmake
|
|
.. cmakev2:include:: ../../../../tools/cmakev2/component_validation.cmake
|