Merge branch 'docs/translate_windowsenv_and_tools' into 'master'

docs: provide CN translation for tools and windows-env

Closes DOC-3321 and DOC-3320

See merge request espressif/esp-idf!18880
pull/9408/head
Shang Zhou 2022-07-08 16:11:46 +08:00
commit 9351731e17
4 zmienionych plików z 68 dodań i 14 usunięć

Wyświetl plik

@ -1,22 +1,27 @@
Migrate Tools to ESP-IDF 5.0
============================
Migrate Tools to ESP-IDF v5.0
=============================
IDF Monitor
-----------
IDF Monitor follows the custom console baud-rate (:ref:`CONFIG_ESP_CONSOLE_UART_BAUDRATE`) by default instead of 115200. Setting a custom baud rate is not supported from menuconfig anymore. A custom baud-rate can be specified from command line with the ``idf.py monitor -b <baud>`` command or through setting environment variables. Please note that the baud-rate argument has been renamed from ``-B`` to ``-b`` in order to be consistent with the global baud-rate ``idf.py -b <baud>``. Run ``idf.py monitor --help`` for more information.
IDF Monitor makes the following changes regarding baud-rate:
Deprecated commands
- IDF monitor now uses the custom console baud-rate (:ref:`CONFIG_ESP_CONSOLE_UART_BAUDRATE`) by default instead of 115200.
- Setting a custom baud from menuconfig is no longer supported.
- A custom baud-rate can be specified from command line with the ``idf.py monitor -b <baud>`` command or through setting environment variables.
- Please note that the baud-rate argument has been renamed from ``-B`` to ``-b`` in order to be consistent with the global baud-rate ``idf.py -b <baud>``. Run ``idf.py monitor --help`` for more information.
Deprecated Commands
-------------------
``idf.py`` sub-commands and ``cmake`` targets are unified to contain ``-`` instead of ``_``. The following changes have been made. Deprecated sub-commands and targets produce a warning. It is advised to migrate to the new ones.
``idf.py`` sub-commands and ``cmake`` target names have been unified to use hyphens (``-``) instead of underscores (``_``). Using a deprecated sub-command or target name will produce a warning. Users are advised to migrate to using the new sub-commands and target names. The following changes have been made:
.. list-table:: Target and sub-command deprecation
.. list-table:: Deprecated Sub-command and Target Names
:widths: 50 50
:header-rows: 1
* - Old name
- New name
* - Old Name
- New Name
* - efuse_common_table
- efuse-common-table
* - efuse_custom_table
@ -39,4 +44,4 @@ Deprecated commands
Esptool
-------
The CONFIG_ESPTOOLPY_FLASHSIZE_DETECT option has been renamed to :ref:`CONFIG_ESPTOOLPY_HEADER_FLASHSIZE_UPDATE` and it is disabled by default. New and existing projects migrated to ESP-IDF v5.0 will have to set :ref:`CONFIG_ESPTOOLPY_FLASHSIZE`. If this is not possible because the flash size is not known at build time then :ref:`CONFIG_ESPTOOLPY_HEADER_FLASHSIZE_UPDATE` can be enabled but this will have the consequence of not appending a SHA256 digest after the image in order that the binary header could be updated with the flash size during flashing without invalidating the digest.
The CONFIG_ESPTOOLPY_FLASHSIZE_DETECT option has been renamed to :ref:`CONFIG_ESPTOOLPY_HEADER_FLASHSIZE_UPDATE` and has been disabled by default. New and existing projects migrated to ESP-IDF v5.0 will have to set :ref:`CONFIG_ESPTOOLPY_FLASHSIZE`. If this is not possible due to an unknown flash size at build time, then :ref:`CONFIG_ESPTOOLPY_HEADER_FLASHSIZE_UPDATE` can be enabled. However, once enabled, to keep the digest valid, a SHA256 digest will no longer be appended to the image when updating the binary header with the flash size during flashing.

Wyświetl plik

@ -1,4 +1,4 @@
Migrate Windows Environment to ESP-IDF 5.0
==========================================
Migrate Windows Environment to ESP-IDF v5.0
===========================================
The Msys/Mingw-based Windows environment support got deprecated in ESP-IDF v4.0 and was entirely removed in v5.0. Please use :ref:`get-started-windows-tools-installer` to set up a compatible environment. The options include Windows Command Line, Power Shell and the graphical user interface based on Eclipse IDE. In addition, a VS Code-based environment can be set up with the supported plugin: https://github.com/espressif/vscode-esp-idf-extension.
The MSYS/MinGW-based Windows environment support has been deprecated since ESP-IDF v4.0 and was entirely removed in v5.0. Please use :ref:`get-started-windows-tools-installer` to set up a compatible Windows environment. The options include Windows Command Line, Power Shell and the graphical user interface based on Eclipse IDE. In addition, a VS Code-based environment can be set up with the `supported plugin <https://github.com/espressif/vscode-esp-idf-extension>`.

Wyświetl plik

@ -1 +1,47 @@
.. include:: ../../en/migration-guides/tools.rst
迁移工具至 ESP-IDF v5.0
============================
IDF 监视器
-----------
IDF 监视器在波特率方面的改动如下:
- 目前IDF 监视器默认遵循自定义的控制台波特率 (:ref:`CONFIG_ESP_CONSOLE_UART_BAUDRATE`),而非 115200。
- ESP-IDF v5.0 不再支持通过 menuconfig 自定义波特率。
- 支持通过设置环境变量或在命令行中使用 ``idf.py monitor -b <baud>`` 命令自定义波特率。
- 注意,为了与全局波特率 ``idf.py -b <baud>`` 保持一致,波特率参数已从 ``-B`` 改名为 ``-b``。请运行 ``idf.py monitor --help`` 获取更多信息。
废弃指令
-------------------
ESP-IDF v5.0 已将 ``idf.py`` 子命令和 ``cmake`` 目标名中的下划线 (``_``) 统一为连字符 (``-``)。使用废弃的子命令及目标名将会触发警告,建议使用更新后的版本。具体改动如下:
.. list-table:: 废弃子命令及目标名
:widths: 50 50
:header-rows: 1
* - 废弃名
- 现用名
* - efuse_common_table
- efuse-common-table
* - efuse_custom_table
- efuse-custom-table
* - erase_flash
- erase-flash
* - partition_table
- partition-table
* - partition_table-flash
- partition-table-flash
* - post_debug
- post-debug
* - show_efuse_table
- show-efuse-table
* - erase_otadata
- erase-otadata
* - read_otadata
- read-otadata
Esptool
-------
CONFIG_ESPTOOLPY_FLASHSIZE_DETECT 选项已重命名为 :ref:`CONFIG_ESPTOOLPY_HEADER_FLASHSIZE_UPDATE`,且默认禁用。迁移到 ESP-IDF v5.0 的新项目和现有项目必须设置 :ref:`CONFIG_ESPTOOLPY_FLASHSIZE`。若因编译时 flash 大小未知而无法设置,可启用 :ref:`CONFIG_ESPTOOLPY_HEADER_FLASHSIZE_UPDATE`。但需注意的是,启用该项后,为在烧录期间使用 flash 大小更新二进制头时不会导致摘要无效,映像后将不再附加 SHA256 摘要。

Wyświetl plik

@ -1 +1,4 @@
.. include:: ../../en/migration-guides/windows-env.rst
迁移 Windows 环境至 ESP-IDF v5.0
==========================================
基于 MSYS/MinGW 的 Windows 环境支持已在 ESP-IDF v4.0 中弃用v5.0 则完全移除了该项服务。请使用 :ref:`get-started-windows-tools-installer` 设置 Windows 兼容环境。目前支持 Windows 命令行、Power Shell 和基于 Eclipse IDE 的图形用户界面等选项。此外,还可以使用 `支持的插件 <https://github.com/espressif/vscode-esp-idf-extension>`,设置基于 VSCode 的环境。