Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/en/additionalfeatures/coredumpdebugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ The IDF-Eclipse plugin allows you to debug the core dump if any crash occurs on

To enable core dump debugging for a project:

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.
2. Click on the ``Core Dump`` from the settings on the left and select ``Data Destination`` as ``UART``.
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.
2. Click ``Core Dump`` in the settings on the left, and set ``Data Destination`` as ``UART``.

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

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.

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

To exit the debug session: simply press the ``stop`` button.
To exit the debug session: simply click the ``stop`` button.
10 changes: 5 additions & 5 deletions docs/en/additionalfeatures/install-esp-components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ Install ESP-IDF Components

:link_to_translation:`zh_CN:[中文]`

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:
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:

1. Right-click on the project in ``Project Explorer`` where you want to add the component, and select ``ESP-IDF: Install ESP-IDF Components``.
2. A new window will open, displaying all available components to be installed.
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.
1. Right-click on the project where you want to add the component in ``Project Explorer``, and select ``ESP-IDF: Install ESP-IDF Components``.
2. A new window will open, displaying all available components that can be installed.
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.

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

Already added components are also shown, but the ``Install`` button text changes to ``Already Added`` and is disabled.
Already-added components are also shown, but the ``Install`` button text changes to ``Already Added`` and is disabled.
11 changes: 7 additions & 4 deletions docs/en/debugproject.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
Debug Your Project
===============================
==================

:link_to_translation:`zh_CN:[中文]`

.. |debug_icon| image:: ../../media/icons/debug.png
:height: 16px
:align: middle

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

1. Create a debug configuration
2. Check whether the board in the created configuration corresponds to the board in use.
1. Create a debug configuration.
2. Check whether the board specified in the created configuration matches the board you are using.

.. note::

.. note::
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>`_.

The fastest way to create a debug configuration is as follows:
Expand Down
3 changes: 0 additions & 3 deletions docs/en/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ Windows

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

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.

macOS/Linux
~~~~~~~~~~~~

Expand Down Expand Up @@ -103,5 +101,4 @@ References
:maxdepth: 1

Update Site Installation Guide <marketplaceupdate>
Windows Offline Installer <windowsofflineinstaller>
Configure CDT Build Environment Variables <additionalfeatures/configureenvvariables>
129 changes: 0 additions & 129 deletions docs/en/windowsofflineinstaller.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/zh_CN/additionalfeatures/coredumpdebugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

:link_to_translation:`en:[English]`

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

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

Expand Down
36 changes: 35 additions & 1 deletion docs/zh_CN/debugproject.rst
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
.. include:: ../en/debugproject.rst
调试项目
========

:link_to_translation:`en:[English]`

.. |debug_icon| image:: ../../media/icons/debug.png
:height: 16px
:align: middle

在大多数情况下,开始调试 ESP-IDF 项目前只需要完成以下两步:

1. 创建调试配置。
2. 检查已创建配置中指定的开发板是否与实际使用的开发板一致。

.. note::

如果使用 Windows 操作系统,可能需要通过 Zadig 安装驱动程序,才能成功运行调试会话。有关详细说明,请参考此 `指南 <https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/jtag-debugging/configure-ft2232h-jtag.html#usb>`_。

创建调试配置的最快方式如下:

1. 在启动栏中展开配置列表并点击 ``New Launch Configuration...``。
2. 选择 ``ESP-IDF GDB OpenOCD Debugging``,然后双击该选项或点击 ``Next``。
3. 上述选项会打开新的调试配置预览界面,用于查看开发板设置。

创建调试配置后,即可继续调试该项目:

1. 选择刚才创建的配置。
2. 选择 ``Debug`` 模式。
3. 点击 ``Debug`` 图标 |debug_icon| 以开始调试。


.. image:: https://github.com/espressif/idf-eclipse-plugin/assets/24419842/1fb0fb9b-a02a-4ed1-bdba-b4b4d36d100f
:alt: 调试过程

要了解更多有关调试配置的内容,请参阅 :ref:`ESP-IDF OpenOCD 调试 <OpenOCDDebugging>`。
3 changes: 0 additions & 3 deletions docs/zh_CN/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ Windows

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

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

macOS/Linux
~~~~~~~~~~~

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

更新站点安装指南 <marketplaceupdate>
Windows 离线安装程序 <windowsofflineinstaller>
配置 CDT 构建环境变量 <additionalfeatures/configureenvvariables>
1 change: 0 additions & 1 deletion docs/zh_CN/windowsofflineinstaller.rst

This file was deleted.

Loading