docs: Update CN translation

This commit is contained in:
Zhang Shuxian
2025-10-22 17:25:02 +08:00
committed by BOT
parent 9155e04f06
commit 30832dcbc8
2 changed files with 76 additions and 4 deletions
+8 -4
View File
@@ -347,7 +347,9 @@ Create a ``CMakePresets.json`` or ``CMakeUserPresets.json`` file in your project
]
}
.. note:: The ``version`` field represents the JSON schema version for CMake Presets. In this example it is set to ``3`` to match the schema supported by ESP-IDFs minimal supported CMake version. If you are using a newer CMake version, you can increase the ``version`` field accordingly - see `CMake Presets`_.
.. note::
The ``version`` field represents the JSON schema version for CMake Presets. In this example it is set to ``3`` to match the schema supported by ESP-IDF's minimal supported CMake version. If you are using a newer CMake version, you can increase the ``version`` field accordingly—see `CMake Presets`_.
**Current Limitations**
@@ -358,10 +360,12 @@ Automatic Preset Selection
If no preset is specified but a ``CMakePresets.json`` file exists, ``idf.py`` will automatically select a preset:
1. If a preset named ``default`` exists, it will be used
2. Otherwise, the first preset in the file will be selected
1. If a preset named ``default`` exists, it will be used.
2. Otherwise, the first preset in the file will be selected.
.. note:: The environment variable ``IDF_PRESET`` can be used to set the default preset name, e.g., ``export IDF_PRESET=production``. Command-line arguments override environment variables.
.. note::
The environment variable ``IDF_PRESET`` can be used to set the default preset name, e.g., ``export IDF_PRESET=production``. Command-line arguments override environment variables.
**SDKCONFIG File Placement**
+68
View File
@@ -306,6 +306,73 @@ MCP 服务器提供以下工具:
claude mcp add esp-idf python /path/to/esp-idf/tools/idf.py mcp-server --env IDF_PATH=/path/to/esp-idf
配置预设:``--preset``
========================
ESP-IDF 支持 `CMake presets`_ 以简化多个构建配置的管理。此功能允许定义可重用的配置配置文件,这些文件指定构建目录、缓存变量和其他 CMake 设置。
.. code-block:: bash
idf.py --preset <preset-name> build
此命令使用指定的配置预设来构建项目。该预设定义了诸如构建目录位置、CMake 缓存变量(包括 ``SDKCONFIG`` 路径)和生成器首选项等设置。
预设定义文件
--------------
在项目根目录下创建一个 ``CMakePresets.json````CMakeUserPresets.json`` 文件来定义 **配置预设**。例如:
.. code-block:: json
{
"version": 3,
"configurePresets": [
{
"name": "default",
"binaryDir": "build/default",
"displayName": "Default Configuration",
"cacheVariables": {
"SDKCONFIG": "./build/default/sdkconfig"
}
},
{
"name": "production",
"binaryDir": "build/production",
"displayName": "Production Build",
"cacheVariables": {
"SDKCONFIG_DEFAULTS": "sdkconfig.defaults.prod_common;sdkconfig.defaults.production",
"SDKCONFIG": "./build/production/sdkconfig"
}
}
]
}
.. note::
字段 ``version`` 代表 CMake Presets 的 JSON 模式版本。在本例中,其值设为 ``3``,以匹配 ESP-IDF 支持的最低 CMake 版本所支持的模式。如果你使用的是更高版本的 CMake,可以相应地增加 ``version`` 字段的值。请参阅 `CMake Presets`_
**当前限制**
- ESP-IDF 目前不支持用于预设继承的 ``inherits`` 字段。包含继承的预设将显示警告。
自动预设选择
----------------
如果未指定预设但存在 ``CMakePresets.json`` 文件,``idf.py`` 将自动选择一个预设:
1. 如果存在名为 ``default`` 的预设,则将使用它。
2. 否则,将选择文件中的第一个预设。
.. note::
环境变量 ``IDF_PRESET`` 可用于设置默认预设名称,例如 ``export IDF_PRESET=production``。命令行参数会覆盖环境变量。
**SDKCONFIG 文件位置**
默认情况下,``sdkconfig`` 文件在项目根目录中创建。但是,在使用 CMake 预设时,可以使用 ``SDKCONFIG`` 缓存变量指定 ``sdkconfig`` 文件的自定义位置。
完整示例请参阅 :example_file:`Multiple Build Configurations Example <build_system/cmake/multi_config/README.md>`
全局选项
==============
@@ -449,3 +516,4 @@ MCP 服务器提供以下工具:
.. _esptool: https://github.com/espressif/esptool/#readme
.. _CCache: https://ccache.dev/
.. _click context: https://click.palletsprojects.com/en/stable/api/#context
.. _CMake presets: https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html