Skip to content

Commit ccb8b96

Browse files
committed
Merge branch 'docs/minimal_build_migration_v5.5' into 'release/v5.5'
docs(migration): add note about MINIMAL_BUILD to 5.5 migration guide (v5.5) See merge request espressif/esp-idf!42560
2 parents 39b9662 + 821ce86 commit ccb8b96

File tree

6 files changed

+26
-0
lines changed

6 files changed

+26
-0
lines changed

docs/en/api-guides/build-system.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,7 @@ To avoid duplication, every component automatically requires some "common" IDF c
605605

606606
The list of common components is: cxx, newlib, freertos, esp_hw_support, heap, log, soc, hal, esp_rom, esp_common, esp_system, xtensa/riscv.
607607

608+
.. _including-components-in-the-build:
608609

609610
Including Components in the Build
610611
---------------------------------
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Build System
2+
============
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
Examples Built with MINIMAL_BUILD Property Enabled
7+
--------------------------------------------------
8+
9+
Most of the examples in ESP-IDF are now being built with the ``MINIMAL_BUILD`` property enabled in their project ``CMakeLists.txt`` by using ``idf_build_set_property(MINIMAL_BUILD ON)``. This reduces the build time by including only the ``main`` component and its transitive dependencies.
10+
11+
As a side effect, only these components appear in menuconfig, as noted in the ``Components config`` menu. With ``MINIMAL_BUILD`` enabled, to make other components visible and compiled, add them as dependencies of the ``main`` component dependency or as its transitive dependencies. For more information, please see :ref:`Including Components in the Build <including-components-in-the-build>`.

docs/en/migration-guides/release-5.x/5.5/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Migration from 5.4 to 5.5
66
.. toctree::
77
:maxdepth: 1
88

9+
build-system
910
security
1011
system
1112
peripherals

docs/zh_CN/api-guides/build-system.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,7 @@ Spark Plug 组件
605605

606606
通用组件包括:cxx、newlib、freertos、esp_hw_support、heap、log、soc、hal、esp_rom、esp_common、esp_system。
607607

608+
.. _including-components-in-the-build:
608609

609610
在构建中导入组件
610611
-----------------
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
构建系统
2+
========
3+
4+
:link_to_translation:`en:[English]`
5+
6+
启用 MINIMAL_BUILD 属性的示例
7+
------------------------------------
8+
9+
目前 ESP-IDF 中的大多数示例均已在其项目的 ``CMakeLists.txt`` 中通过 ``idf_build_set_property(MINIMAL_BUILD ON)`` 启用 ``MINIMAL_BUILD`` 属性。通过仅将 ``main`` 组件及其传递依赖项包含在构建中,缩短了示例的构建时间。
10+
11+
带来的影响是:如 ``Components config`` 菜单中所述,只有这些组件会出现在 menuconfig 中。启用 ``MINIMAL_BUILD`` 后,若要使其他组件在 menuconfig 中可见并参与编译,需将其添加为 ``main`` 组件的依赖项或传递依赖项。更多信息请参阅 :ref:`在构建中导入组件 <including-components-in-the-build>`。

docs/zh_CN/migration-guides/release-5.x/5.5/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
.. toctree::
77
:maxdepth: 1
88

9+
build-system
910
security
1011
system
1112
peripherals

0 commit comments

Comments
 (0)