From 86352f9d1f44147a86e30a14cd96d965e8196155 Mon Sep 17 00:00:00 2001 From: Frantisek Hrbata Date: Tue, 12 Aug 2025 11:26:03 +0200 Subject: [PATCH 1/2] docs(migration): add note about MINIMAL_BUILD to 5.5 migration guide Signed-off-by: Frantisek Hrbata --- docs/en/api-guides/build-system.rst | 1 + .../en/migration-guides/release-5.x/5.5/build-system.rst | 9 +++++++++ docs/en/migration-guides/release-5.x/5.5/index.rst | 1 + docs/zh_CN/api-guides/build-system.rst | 1 + .../migration-guides/release-5.x/5.5/build-system.rst | 1 + docs/zh_CN/migration-guides/release-5.x/5.5/index.rst | 1 + 6 files changed, 14 insertions(+) create mode 100644 docs/en/migration-guides/release-5.x/5.5/build-system.rst create mode 100644 docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst diff --git a/docs/en/api-guides/build-system.rst b/docs/en/api-guides/build-system.rst index 3d17759bfd..76500407a6 100644 --- a/docs/en/api-guides/build-system.rst +++ b/docs/en/api-guides/build-system.rst @@ -605,6 +605,7 @@ To avoid duplication, every component automatically requires some "common" IDF c The list of common components is: cxx, newlib, freertos, esp_hw_support, heap, log, soc, hal, esp_rom, esp_common, esp_system, xtensa/riscv. +.. _including-components-in-the-build: Including Components in the Build --------------------------------- diff --git a/docs/en/migration-guides/release-5.x/5.5/build-system.rst b/docs/en/migration-guides/release-5.x/5.5/build-system.rst new file mode 100644 index 0000000000..3559508689 --- /dev/null +++ b/docs/en/migration-guides/release-5.x/5.5/build-system.rst @@ -0,0 +1,9 @@ +Build System +============ + +:link_to_translation:`zh_CN:[中文]` + +Examples built with the MINIMAL_BUILD build property enabled +------------------------------------------------------------ + +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 ` diff --git a/docs/en/migration-guides/release-5.x/5.5/index.rst b/docs/en/migration-guides/release-5.x/5.5/index.rst index 7b5782a959..69462fb773 100644 --- a/docs/en/migration-guides/release-5.x/5.5/index.rst +++ b/docs/en/migration-guides/release-5.x/5.5/index.rst @@ -6,6 +6,7 @@ Migration from 5.4 to 5.5 .. toctree:: :maxdepth: 1 + build-system security system peripherals diff --git a/docs/zh_CN/api-guides/build-system.rst b/docs/zh_CN/api-guides/build-system.rst index 113a822fd4..614da7e395 100644 --- a/docs/zh_CN/api-guides/build-system.rst +++ b/docs/zh_CN/api-guides/build-system.rst @@ -605,6 +605,7 @@ Spark Plug 组件 通用组件包括：cxx、newlib、freertos、esp_hw_support、heap、log、soc、hal、esp_rom、esp_common、esp_system。 +.. _including-components-in-the-build: 在构建中导入组件 ----------------- diff --git a/docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst b/docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst new file mode 100644 index 0000000000..e836044fed --- /dev/null +++ b/docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst @@ -0,0 +1 @@ +.. include:: ../../../../en/migration-guides/release-5.x/5.5/build-system.rst diff --git a/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst b/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst index 139e094317..85bb8372ae 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.5/index.rst @@ -6,6 +6,7 @@ .. toctree:: :maxdepth: 1 + build-system security system peripherals From 821ce86a094466c8ca10754455d325fc20a99066 Mon Sep 17 00:00:00 2001 From: Zhang Shuxian Date: Thu, 9 Oct 2025 17:51:41 +0800 Subject: [PATCH 2/2] docs: Update translation for build-system.rst --- .../release-5.x/5.5/build-system.rst | 8 +++++--- .../release-5.x/5.5/build-system.rst | 12 +++++++++++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/en/migration-guides/release-5.x/5.5/build-system.rst b/docs/en/migration-guides/release-5.x/5.5/build-system.rst index 3559508689..763b15f519 100644 --- a/docs/en/migration-guides/release-5.x/5.5/build-system.rst +++ b/docs/en/migration-guides/release-5.x/5.5/build-system.rst @@ -3,7 +3,9 @@ Build System :link_to_translation:`zh_CN:[中文]` -Examples built with the MINIMAL_BUILD build property enabled ------------------------------------------------------------- +Examples Built with MINIMAL_BUILD Property Enabled +-------------------------------------------------- -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 ` +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. + +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 `. diff --git a/docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst b/docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst index e836044fed..9c5e855df5 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.5/build-system.rst @@ -1 +1,11 @@ -.. include:: ../../../../en/migration-guides/release-5.x/5.5/build-system.rst +构建系统 +======== + +:link_to_translation:`en:[English]` + +启用 MINIMAL_BUILD 属性的示例 +------------------------------------ + +目前 ESP-IDF 中的大多数示例均已在其项目的 ``CMakeLists.txt`` 中通过 ``idf_build_set_property(MINIMAL_BUILD ON)`` 启用 ``MINIMAL_BUILD`` 属性。通过仅将 ``main`` 组件及其传递依赖项包含在构建中，缩短了示例的构建时间。 + +带来的影响是：如 ``Components config`` 菜单中所述，只有这些组件会出现在 menuconfig 中。启用 ``MINIMAL_BUILD`` 后，若要使其他组件在 menuconfig 中可见并参与编译，需将其添加为 ``main`` 组件的依赖项或传递依赖项。更多信息请参阅 :ref:`在构建中导入组件 `。