Skip to content

Commit 4acd222

Browse files
kolipakakondalkolipakakondal
committed
update docs
1 parent 194661f commit 4acd222

File tree

10 files changed

+187
-1
lines changed

10 files changed

+187
-1
lines changed

‎docs/en/additionalfeatures.rst‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ Additional IDE Features
66
ESP-IDF Application Size Analysis<additionalfeatures/application-size-analysis>
77
ESP-IDF Terminal<additionalfeatures/esp-terminal>
88
Install ESP-IDF Components<additionalfeatures/install-esp-components>
9-
9+
LSP C/C++ Editor<additionalfeatures/lspeditor>
10+
CMake Editor<additionalfeatures/cmakeeditor>
11+
Configure CDT Build Environment Variables<additionalfeatures/configureenvvariables>
12+
Configuring Clang Toolchain<additionalfeatures/clangtoolchain>
13+
Switching Language<additionalfeatures/switchlanguage>

‎docs/en/additionalfeatures/application-size-analysis.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
ESP-IDF Application Size Analysis
22
===================================
3+
4+
The Application Size Analysis editor provides a way to analyze the static memory footprint of your application. It has two sections:
5+
6+
- The **Overview** section provides a summary of the application's memory usage;
7+
- The **Details** section includes in-depth details about components and per-symbol level memory information.
8+
9+
The **Details** table viewer also provides searching and sorting capabilities on various columns.
10+
11+
To launch the Application Size Analysis editor:
12+
13+
#. Right-click on the project.
14+
#. Select **ESP-IDF > Application Size Analysis** menu option to launch the editor.
15+
16+
**Application Size Analysis - Overview**
17+
18+
.. image:: ../../../media/sizeanalysis_overview.png
19+
:alt: Application Size Analysis - Overview
20+
21+
**Application Size Analysis - Details**
22+
23+
.. image:: ../../../media/sizeanalysis_details.png
24+
:alt: Application Size Analysis - Details

‎docs/en/additionalfeatures/clangtoolchain.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Configuring Clang Toolchain
2+
===========================
3+
4+
1. After creating a new project, edit the project configuration.
5+
6+
.. image:: https://user-images.githubusercontent.com/24419842/194882285-9faadb5d-0fe2-4012-bb6e-bc23dedbdbd2.png
7+
:alt: Project Configuration
8+
9+
2. Go to the ``Build Settings`` tab and select the clang toolchain:
10+
11+
.. image:: https://user-images.githubusercontent.com/24419842/194882462-3c0fd660-b223-4caf-964d-58224d91b518.png
12+
:alt: Clang Toolchain Selection
13+
14+
.. note::
15+
Clang toolchain is currently an experimental feature, and you may encounter build issues due to incompatibility with ESP-IDF. The following describes how to address the most common build issues on the current ESP-IDF master (ESP-IDF v5.1-dev-992-gaf28c1fa21-dirty). To work around clang build errors, please refer to `this workaround guide <https://github.com/espressif/idf-eclipse-plugin/blob/master/WORKAROUNDS.md#clang-toolchain-buid-errors>`_.

‎docs/en/additionalfeatures/cmakeeditor.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
CMake Editor
2+
============
3+
4+
The CMake Editor Plug-in is integrated with the IDF Plugin for editing CMake files, such as ``CMakeLists.txt``. It provides syntax coloring, CMake command content assistance, and code templates.
5+
6+
.. image:: ../../../media/cmake_editor_ca.png
7+
:alt: CMake Editor with content assist
8+
9+
CMake editor preferences can be controlled using **Eclipse > Preferences > CMakeEd**.
10+
11+
.. image:: ../../../media/cmake_editor_preferences.png
12+
:alt: CMake editor preferences

‎docs/en/additionalfeatures/configureenvvariables.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Configuring Environment Variables
2+
================================
3+
4+
All the required environment variables are automatically configured by the IDE during the ESP-IDF and Tools installation process (``Espressif > ESP-IDF Manager > Add ESP-IDF``). You can verify these variables in the Preferences page under ``C/C++ > Build > Environment``.
5+
6+
.. image:: ../../../media/2_environment_pref.png
7+
:alt: Environment Preferences

‎docs/en/additionalfeatures/esp-terminal.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
ESP-IDF Terminal
22
===============================
3+
4+
This would launch a local terminal with all the environment variables set under ``Preferences`` > ``C/C++`` > ``Build`` > ``Environment``. The default working directory would be either the currently selected project or ``IDF_PATH`` if there is no project selected.
5+
6+
The terminal ``PATH`` is also configured with ``esptool``, ``espcoredump``, ``partition_table``, and ``app_update`` component paths, so it is convenient to access them directly from the ESP-IDF terminal.
7+
8+
To launch the ESP-IDF Terminal:
9+
10+
- Click on the ``Open a Terminal`` icon from the toolbar.
11+
- Choose ``ESP-IDF Terminal`` from the terminal drop-down and click ``OK`` to launch a terminal.
12+
13+
.. image:: ../../../media/idf_terminal.png
14+
:alt: ESP-IDF Terminal

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
11
Install ESP-IDF Components
22
===============================
3+
You can install the ESP-IDF Components directly into your project from the available components online. Follow the steps below:
4+
5+
- Right-click on the project in ``Project Explorer`` where you want to add the component, and select ``Install ESP-IDF Components``.
6+
7+
.. image:: ../../../media/ESP-IDF_Components/install_components.png
8+
:alt: Install ESP-IDF Components
9+
10+
A new window will open, displaying all available components to be installed.
11+
12+
- 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.
13+
14+
.. image:: ../../../media/ESP-IDF_Components/components_window.png
15+
:alt: ESP-IDF Components Window
16+
17+
Already added components are also shown, but the ``Install`` button text changes to ``Already Added`` and is disabled.

‎docs/en/additionalfeatures/lspeditor.rst‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
LSP C/C++ Editor
2+
=================
3+
4+
Starting with Espressif IDE 3.0.0, the LSP Editor is the default code editor, which differs in several ways from the previous default editor. Below are the most notable differences:
5+
6+
Formatting
7+
----------
8+
9+
To customize formatting, open the ``.clang-format`` file located in your project. By default, the file contains the following content:
10+
11+
.. code-block:: none
12+
13+
BasedOnStyle: LLVM
14+
UseTab: Always
15+
IndentWidth: 4
16+
TabWidth: 4
17+
PackConstructorInitializers: NextLineOnly
18+
BreakConstructorInitializers: AfterColon
19+
IndentAccessModifiers: false
20+
AccessModifierOffset: -4
21+
22+
You can also disable formatting for specific folders by using the ``DisableFormat: true`` option. For example, if you want to disable formatting for the ``managed_components`` folder in a project structured like this:
23+
24+
.. code-block:: none
25+
26+
project
27+
├── managed_components
28+
│ └── .clang-format
29+
├── main
30+
└── .clang-format
31+
32+
Add the ``DisableFormat: true`` option to the ``.clang-format`` file in the ``managed_components`` folder. This flag tells ClangFormat to completely ignore this specific ``.clang-format`` file and its formatting rules within the ``managed_components`` directory.
33+
34+
For more information about available style options, refer to `the Clang-Format Style Options guide <https://clang.llvm.org/docs/ClangFormatStyleOptions.html#configurable-format-style-options>`_.
35+
36+
Search
37+
------
38+
39+
The "search text" option in the right-click menu is currently unavailable in the LSP-based C/C++ Editor. However, you can use the toolbar menu **Search > Text > Workspace** as a workaround.
40+
41+
Inlay Hints
42+
-----------
43+
44+
The LSP Editor has inlay hints enabled by default. If you prefer not to use them, you can disable this feature by editing the ``.clangd`` file:
45+
46+
.. code-block:: none
47+
48+
CompileFlags:
49+
CompilationDatabase: build
50+
Remove:
51+
- -m*
52+
- -f*
53+
54+
InlayHints:
55+
Enabled: No
56+
57+
Searching ESP-IDF Components
58+
----------------------------
59+
60+
To browse ESP-IDF components, follow these steps:
61+
62+
- Create a new project.
63+
- Add the ESP-IDF components folder as a virtual folder to the newly created project.
64+
- Press **Ctrl + Shift + T** or **Ctrl + Shift + R**.
65+
- You should now be able to browse the ESP-IDF component files.
66+
- To search for a specific function or keyword, use the Search menu in the toolbar.
67+
68+
Creating a Virtual Folder
69+
-------------------------
70+
71+
- Navigate to **New > Folder**.
72+
- Click on **Advanced**.
73+
- Select **Link to alternate Location (Linked Folder)**.
74+
- Click **Browse** and select the ``ESP-IDF components`` folder.
75+
76+
It is recommended to always create a new project instead of modifying your current one to avoid unnecessary Git files and error markers created by the indexer for the components folder. Since both projects will be in the same workspace, you should be able to search anywhere within your workspace.

‎docs/en/additionalfeatures/switchlanguage.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Switching Language in Espressif IDE
2+
=======================================
3+
To change the plugin language, a menu is provided to show the list of available languages for the plugin.
4+
5+
1. Click on the ``Espressif`` menu from the menu bar.
6+
2. Select ``Change Language`` from the drop-down menu.
7+
3. From the submenu, select the language you want.
8+
4. The IDE will restart with the selected language.
9+
10+
.. image:: ../../../media/change_language.png
11+
:alt: Change Language Menu

‎docs/en/configureproject.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
Configure Your Project
22
===============================
3+
4+
Project configuration is stored in a single file called ``sdkconfig`` located in the root directory of the project. This configuration file can be modified using the ``SDK Configuration Editor``.
5+
6+
To launch the SDK Configuration Editor:
7+
8+
#. Navigate to the ``sdkconfig`` file.
9+
#. Double-click on the file to launch the SDK Configuration Editor.
10+
#. Use ``Ctrl+S`` or ``Command+S`` based on your OS to save the changes. You can also use the Eclipse ``Save`` button from the toolbar.
11+
#. To revert changes made in the SDK Configuration Editor, either close the editor without saving or right-click on the ``sdkconfig`` file and select ``Load sdkconfig`` to revert the changes from the editor.
12+
13+
.. image:: ../../media/13_sdkconfig_editor.png
14+
:alt: SDK Configuration Editor

0 commit comments

Comments
 (0)