Skip to content

Commit

Permalink
docs: Edit the CN translation for settings.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Shen765 committed Nov 18, 2024
1 parent 3674c3e commit 687d6c6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs_espressif/en/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ These are the configuration settings that ESP-IDF extension contributes to your
* - idf.buildPath
- Custom build directory name for extension commands (Default: \${workspaceFolder}/build)
* - idf.buildPathWin
- Custom build directory name for extension commands (Default: \${workspaceFolder}\\build)
- Custom build directory name for extension commands in Windows (Default: \${workspaceFolder}\\build)
* - idf.sdkconfigFilePath
- Absolute path for the sdkconfig file
* - idf.sdkconfigDefaults
Expand Down Expand Up @@ -114,8 +114,8 @@ These settings are specific to the ESP32 Chip/Board.
This is how the extension uses them:

1. **idf.flashBaudRate** is the baud rate value used for the **ESP-IDF: Flash your Project** command and `Debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`_.
2. **idf.monitorBaudRate** is the ESP-IDF Monitor baud rate value and fallback from your project's sdkconfig ``CONFIG_ESPTOOLPY_MONITOR_BAUD`` (idf.py monitor' baud rate). This value can also be override by setting the environment variable ``IDF_MONITOR_BAUD`` or ``MONITORBAUD`` in your system environment variables or this extension's **idf.customExtraVars** configuration setting.
3. **idf.openOcdConfigs** is used to store an string array of OpenOCD scripts directory relative path config files to use with OpenOCD server. (e.g.,``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``). More information can be found in `OpenOCD JTAG Target Configuration <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_.
2. **idf.monitorBaudRate** is the ESP-IDF Monitor baud rate value and fallback from your project's sdkconfig ``CONFIG_ESPTOOLPY_MONITOR_BAUD`` (idf.py monitor' baud rate). You can override this value by setting the ``IDF_MONITOR_BAUD`` or ``MONITORBAUD`` environment variables, or by configuring it through **idf.customExtraVars** setting of the extension.
3. **idf.openOcdConfigs** stores an string array of relative paths to OpenOCD script configuration files, which are used with OpenOCD server. (e.g.,``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``). More information can be found in `OpenOCD JTAG Target Configuration <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_.
4. **idf.port** (or **idf.portWin** in Windows) is used as the serial port value for the extension commands.
5. **idf.openOcdDebugLevel** is the log level for OpenOCD server output from 0 to 4.
6. **idf.openOcdLaunchArgs** is the launch arguments string array for OpenOCD. The resulting OpenOCD launch command looks like this: ``openocd -d${idf.openOcdDebugLevel} -f ${idf.openOcdConfigs} ${idf.openOcdLaunchArgs}``.
Expand Down
12 changes: 6 additions & 6 deletions docs_espressif/zh_CN/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ ESP-IDF 设置

:link_to_translation:`en:[English]`

此扩展提供一些特殊设置,可在 ``settings.json`` 文件中进行更新,或按照下列步骤在 VS Code 设置首选项菜单栏中更新:
此扩展提供一些设置,可在 ``settings.json`` 文件中进行更新,或按照下列步骤在 VS Code 设置首选项菜单栏中更新:

- 点击 **查看** > **命令面板**。

- 输入 **首选项:打开设置 (UI)**,点击该命令,打开设置管理窗口。

.. note::

请注意,配置此扩展时,``~``、``%VARNAME%`` 和 ``$VARNAME`` 都无法被识别到。请使用 ``${env:VARNAME}`` 来设置路径中的环境变量,例如 ``${env:HOME}``。也可以通过 ``${config:SETTINGID}`` 来引用其他配置参数,例如 ``${config:idf.espIdfPath}``。
请注意,配置此扩展时,``~``、``%VARNAME%`` 和 ``$VARNAME`` 都无法被识别。请使用 ``${env:VARNAME}`` 来设置路径中的环境变量,例如 ``${env:HOME}``。也可以通过 ``${config:SETTINGID}`` 来引用其他配置参数,例如 ``${config:idf.espIdfPath}``。

在运行 **设置乐鑫设备目标** 等命令时,**idf.saveScope** 可指定保存设置的位置。可选择将设置保存在全局(用户设置)、工作区或工作区文件夹。请使用 **选择设置存储范围** 命令来选择保存设置的位置。

Expand All @@ -22,7 +22,7 @@ ESP-IDF 设置
ESP-IDF 相关设置
----------------

下表展示了 ESP-IDF 扩展为 VS Code 编辑器设置提供的配置选项
下表展示了 VS Code 编辑器设置中 ESP-IDF 扩展的配置选项

.. list-table::
:widths: 10 20
Expand All @@ -33,7 +33,7 @@ ESP-IDF 相关设置
* - idf.buildPath
- 扩展命令的自定义构建目录名称(默认值:\${workspaceFolder}/build)
* - idf.buildPathWin
- 扩展命令的自定义构建目录名称(默认值:\${workspaceFolder}\\build)
- Windows 系统中扩展命令的自定义构建目录名称(默认值:\${workspaceFolder}\\build)
* - idf.sdkconfigFilePath
- sdkconfig 文件的绝对路径
* - idf.sdkconfigDefaults
Expand Down Expand Up @@ -115,14 +115,14 @@ ESP-IDF 相关设置

1. **idf.flashBaudRate** 是用于 **ESP-IDF:烧录项目** 命令和 `Debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`_ 的烧录速率。
2. **idf.monitorBaudRate** 是 ESP-IDF 的监视器速率值,默认会从项目的 sdkconfig 配置项``CONFIG_ESPTOOLPY_MONITOR_BAUD``(即 idf.py monitor 命令的波特率)中获取该值作为回退值 (fallback)。该值也可以通过系统环境变量中的 ``IDF_MONITOR_BAUD`` 或 ``MONITORBAUD`` 进行覆盖,或者在扩展的 **idf.customExtraVars** 配置项中指定。
3. **idf.openOcdConfigs** 用于存储一组 OpenOCD 脚本目录相对路径配置文件的字符串数组,以便与 OpenOCD 服务器一同使用。(例如,``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``。详情请参阅 `OpenOCD JTAG 目标配置 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_。
3. **idf.openOcdConfigs** 用于存储一个字符串数组,其中每个字符串都代表相对于 OpenOCD 脚本目录的配置文件路径。这些配置文件将被用来设置 OpenOCD 服务器,例如:``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``。详情请参阅 `OpenOCD JTAG 目标配置 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_。
4. **idf.port** (Windows 系统中为 **idf.portWin**)用作扩展命令的串口值。
5. **idf.openOcdDebugLevel** 是 OpenOCD 服务器输出的日志级别,范围为 0 到 4。
6. **idf.openOcdLaunchArgs** 是用于配置 OpenOCD 启动的参数字符串数组。生成的 OpenOCD 启动命令格式如下:``openocd -d${idf.openOcdDebugLevel} -f ${idf.openOcdConfigs} ${idf.openOcdLaunchArgs}``。

.. note::

* 使用 **ESP-IDF:设置乐鑫设备目标** 命令时,当前 sdkconfig 文件中的 IDF_TARGET 配置项将被选中的乐鑫芯片所覆盖,并将 **idf.openOcdConfigs** 设置为芯片默认的 OpenOCD 配置文件。
* 使用 **ESP-IDF:设置乐鑫设备目标** 命令时,当前 sdkconfig 文件中的 IDF_TARGET 配置项将被选中的芯片所覆盖,并将 **idf.openOcdConfigs** 设置为芯片默认的 OpenOCD 配置文件。
* 如果只想自定义 **idf.openOcdConfigs**,可以使用 **ESP-IDF:选择 OpenOCD 开发板配置** 命令,或直接修改 ``settings.json`` 文件。

代码覆盖率相关设置
Expand Down

0 comments on commit 687d6c6

Please sign in to comment.