Skip to content

Commit 86352f9

Browse files
committed
docs(migration): add note about MINIMAL_BUILD to 5.5 migration guide
Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
1 parent 42e7e40 commit 86352f9

File tree

6 files changed

+14
-0
lines changed

6 files changed

+14
-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: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Build System
2+
============
3+
4+
:link_to_translation:`zh_CN:[中文]`
5+
6+
Examples built with the MINIMAL_BUILD 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 change has reduced the build time for the examples because only the ``main`` component and its transitive dependencies are included in the build. As a side effect, only the configuration for these components will be available in menuconfig, which is also noted in the ``Components config`` menu. With ``MINIMAL_BUILD`` enabled, a component needs to be added to the build as a ``main`` component dependency or as its transitive dependency to become visible in menuconfig and be compiled. 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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../en/migration-guides/release-5.x/5.5/build-system.rst

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)