Skip to content

Commit 0b9061e

Browse files
committed
docs: Provide CN translation for two docs
1 parent db8ad57 commit 0b9061e

File tree

9 files changed

+51
-150
lines changed

9 files changed

+51
-150
lines changed

docs/en/additionalfeatures/coredumpdebugging.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ The IDF-Eclipse plugin allows you to debug the core dump if any crash occurs on
99

1010
To enable core dump debugging for a project:
1111

12-
1. You need to enable it first in ``sdkconfig``. Launch the ``sdkconfig`` in the project root by double-clicking on it which will open the configuration editor.
13-
2. Click on the ``Core Dump`` from the settings on the left and select ``Data Destination`` as ``UART``.
12+
1. You need to enable it first in ``sdkconfig``. Open the ``sdkconfig`` in the project root by double-clicking on it, which will launch the configuration editor.
13+
2. Click ``Core Dump`` in the settings on the left, and set ``Data Destination`` as ``UART``.
1414

1515
.. image:: ../../../media/CoreDumpDebugging/sdkconfig_editor.png
1616

1717
This enables core dump debugging. When you connect a serial monitor for the project and a crash occurs, Eclipse automatically loads the core dump and opens the debug perspective, allowing you to inspect all the information contained in the dump.
1818

1919
You can view the registers and stack trace, and even check the value of variables in the stack frame.
2020

21-
To exit the debug session: simply press the ``stop`` button.
21+
To exit the debug session: simply click the ``stop`` button.

docs/en/additionalfeatures/install-esp-components.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Install ESP-IDF Components
33

44
:link_to_translation:`zh_CN:[中文]`
55

6-
You can install the ESP-IDF Components directly into your project from the available components from the `ESP-IDF Component Registry <https://components.espressif.com/>`_. Follow the steps below:
6+
You can install the ESP-IDF Components directly into your project from the available components in `ESP-IDF Component Registry <https://components.espressif.com/>`_. Follow the steps below:
77

8-
1. Right-click on the project in ``Project Explorer`` where you want to add the component, and select ``ESP-IDF: Install ESP-IDF Components``.
9-
2. A new window will open, displaying all available components to be installed.
10-
3. In the window, you can click on the ``Install`` button to add the selected component to the project. To access the README file for a component, click ``More Info``, which opens the README in your browser.
8+
1. Right-click on the project where you want to add the component in ``Project Explorer``, and select ``ESP-IDF: Install ESP-IDF Components``.
9+
2. A new window will open, displaying all available components that can be installed.
10+
3. In the window, click the ``Install`` button to add the selected component to your project. To view a component's README file, click ``More Info`` to open the README in your browser.
1111

1212
.. image:: ../../../media/ESP-IDF_Components/components_window.png
1313
:alt: ESP-IDF Components Window
1414

15-
Already added components are also shown, but the ``Install`` button text changes to ``Already Added`` and is disabled.
15+
Already-added components are also shown, but the ``Install`` button text changes to ``Already Added`` and is disabled.

docs/en/debugproject.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
Debug Your Project
2-
===============================
2+
==================
3+
4+
:link_to_translation:`zh_CN:[中文]`
35

46
.. |debug_icon| image:: ../../media/icons/debug.png
57
:height: 16px
68
:align: middle
79

810
In most cases, only two things are required to start debugging an ESP-IDF project:
911

10-
1. Create a debug configuration
11-
2. Check whether the board in the created configuration corresponds to the board in use.
12+
1. Create a debug configuration.
13+
2. Check whether the board specified in the created configuration matches the board you are using.
14+
15+
.. note::
1216

13-
.. note::
1417
If you're using Windows, you may need to install drivers using Zadig to run a debug session successfully. For detailed instructions, please refer to this `guide <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html#configure-usb-drivers>`_.
1518

1619
The fastest way to create a debug configuration is as follows:

docs/en/installation.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ Windows
2929

3030
For Windows users, Espressif-IDE is available with ESP-IDF as an offline installer.
3131

32-
To download and install it, follow the instructions provided :ref:`here <windowsofflineinstaller>`. This guide will walk you through the installation process for Java, Git, CMake, ESP-IDF, IDF Tools, Device Drivers, and Espressif-IDE to help you get started.
33-
3432
macOS/Linux
3533
~~~~~~~~~~~~
3634

@@ -103,5 +101,4 @@ References
103101
:maxdepth: 1
104102

105103
Update Site Installation Guide <marketplaceupdate>
106-
Windows Offline Installer <windowsofflineinstaller>
107104
Configure CDT Build Environment Variables <additionalfeatures/configureenvvariables>

docs/en/windowsofflineinstaller.rst

Lines changed: 0 additions & 129 deletions
This file was deleted.

docs/zh_CN/additionalfeatures/coredumpdebugging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
:link_to_translation:`en:[English]`
77

8-
IDF-Eclipse 插件允许在芯片发生崩溃且已完成相关配置时调试核心转储。目前,仅支持通过 UART 捕获和调试核心转储。
8+
在完成相关配置的前提下,IDF-Eclipse 插件可以在芯片发生崩溃时调试核心转储。目前,仅支持通过 UART 捕获和调试核心转储。
99

1010
可参照以下步骤为项目启用核心转储调试:
1111

docs/zh_CN/debugproject.rst

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,35 @@
1-
.. include:: ../en/debugproject.rst
1+
调试项目
2+
========
3+
4+
:link_to_translation:`en:[English]`
5+
6+
.. |debug_icon| image:: ../../media/icons/debug.png
7+
:height: 16px
8+
:align: middle
9+
10+
在大多数情况下,开始调试 ESP-IDF 项目前只需要完成以下两步:
11+
12+
1. 创建调试配置。
13+
2. 检查已创建配置中指定的开发板是否与实际使用的开发板一致。
14+
15+
.. note::
16+
17+
如果使用 Windows 操作系统,可能需要通过 Zadig 安装驱动程序,才能成功运行调试会话。有关详细说明,请参考此 `指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html#usb>`_。
18+
19+
创建调试配置的最快方式如下:
20+
21+
1. 在启动栏中展开配置列表并点击 ``New Launch Configuration...``。
22+
2. 选择 ``ESP-IDF GDB OpenOCD Debugging``,然后双击该选项或点击 ``Next``。
23+
3. 上述选项会打开新的调试配置预览界面,用于查看开发板设置。
24+
25+
创建调试配置后,即可继续调试该项目:
26+
27+
1. 选择刚才创建的配置。
28+
2. 选择 ``Debug`` 模式。
29+
3. 点击 ``Debug`` 图标 |debug_icon| 以开始调试。
30+
31+
32+
.. image:: https://github.com/espressif/idf-eclipse-plugin/assets/24419842/1fb0fb9b-a02a-4ed1-bdba-b4b4d36d100f
33+
:alt: 调试过程
34+
35+
要了解更多有关调试配置的内容,请参阅 :ref:`ESP-IDF OpenOCD 调试 <OpenOCDDebugging>`。

docs/zh_CN/installation.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ Windows
2929

3030
对于 Windows 用户,Espressif-IDE 提供带有 ESP-IDF 的离线安装包。
3131

32-
请参阅 :ref:`此文 <windowsofflineinstaller>` 下载并安装 Espressif-IDE。该指南将引导你完成 Java、Git、CMake、ESP-IDF、IDF 工具、设备驱动以及 Espressif-IDE 的安装流程,帮助你快速入门。
33-
3432
macOS/Linux
3533
~~~~~~~~~~~
3634

@@ -103,5 +101,4 @@ Espressif-IDE 提供了工具管理视图,可用来激活可用的 ESP-IDF 版
103101
:maxdepth: 1
104102

105103
更新站点安装指南 <marketplaceupdate>
106-
Windows 离线安装程序 <windowsofflineinstaller>
107104
配置 CDT 构建环境变量 <additionalfeatures/configureenvvariables>

docs/zh_CN/windowsofflineinstaller.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)