Skip to content

Commit

Permalink
Merge branch 'docs/remove_duplication_in_build_system_docs' into 'mas…
Browse files Browse the repository at this point in the history
…ter'

fix(docs/build_system): Remove duplication about project_include.cmake usage

See merge request espressif/esp-idf!27084
  • Loading branch information
sudeep-mohanty committed Nov 11, 2023
2 parents 9d49241 + 348206f commit 526aa01
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 4 deletions.
2 changes: 0 additions & 2 deletions docs/en/api-guides/build-system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -709,8 +709,6 @@ This is an equivalent to ``project_include.cmake`` for :ref:`component-configura

Take care when adding configuration values in this file, as they will be included across the entire project configuration. Where possible, it's generally better to create a KConfig file for :ref:`component-configuration`.

``project_include.cmake`` files are used inside ESP-IDF, for defining project-wide build features such as ``esptool.py`` command line arguments and the ``bootloader`` "special app".


Wrappers to Redefine or Extend Existing Functions
-------------------------------------------------
Expand Down
2 changes: 0 additions & 2 deletions docs/zh_CN/api-guides/build-system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -709,8 +709,6 @@ KConfig.projbuild

在此文件中添加配置时要小心,因为这些配置会包含在整个项目配置中。在可能的情况下,请为 :ref:`component-configuration` 创建 KConfig 文件。

``project_include.cmake`` 文件在 ESP-IDF 内部使用,以定义项目范围内的构建功能,比如 ``esptool.py`` 的命令行参数和 ``bootloader`` 这个特殊的应用程序。


通过封装对现有函数进行重新定义或扩展
-------------------------------------
Expand Down

0 comments on commit 526aa01

Please sign in to comment.