You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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``.
4
+
:link_to_translation:`zh_CN:[中文]`
5
+
6
+
Once you install ESP-IDF through `EIM <https://docs.espressif.com/projects/idf-im-ui/en/latest/>`_, all required environment variables are automatically configured by the IDE when you activate the ESP-IDF in ``Espressif`` > ``ESP-IDF Manager``. You can verify these variables on the ``Preferences`` page under ``C/C++`` > ``Build`` > ``Environment``.
Copy file name to clipboardExpand all lines: docs/en/additionalfeatures/lspeditor.rst
+19-16Lines changed: 19 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,9 @@
1
1
LSP C/C++ Editor
2
-
=================
2
+
================
3
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:
4
+
:link_to_translation:`zh_CN:[中文]`
5
+
6
+
Starting with Espressif IDE 3.0.0, the LSP Editor becomes the default code editor and behaves differently from the previous default editor. The most notable differences are listed below.
5
7
6
8
Formatting
7
9
----------
@@ -25,18 +27,18 @@ You can also disable formatting for specific folders by using the ``DisableForma
25
27
26
28
project
27
29
├── managed_components
28
-
│ └── .clang-format
30
+
│ └── .clang-format
29
31
├── main
30
32
└── .clang-format
31
33
32
34
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
35
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>`_.
36
+
For more information about available style options, refer to `Configurable Format Style Options <https://clang.llvm.org/docs/ClangFormatStyleOptions.html#configurable-format-style-options>`_.
35
37
36
38
Search
37
39
------
38
40
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.
41
+
The ``Search Text`` option in the right-click menu is currently unavailable in the LSP-based C/C++ Editor. However, as a workaround, you can use ``Search`` > ``Text`` > ``Workspace`` from the toolbar menu.
40
42
41
43
Inlay Hints
42
44
-----------
@@ -59,28 +61,29 @@ Searching ESP-IDF Components
59
61
60
62
To browse ESP-IDF components, follow these steps:
61
63
62
-
- Create a new project.
63
-
- Add the ESP-IDF components folder as a virtual folder to the newly created project.
4. You should now be able to browse the ESP-IDF component files.
68
+
5. To search for a specific function or keyword, use the ``Search`` menu in the toolbar.
67
69
68
70
Creating a Virtual Folder
69
71
~~~~~~~~~~~~~~~~~~~~~~~~~
70
72
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.
73
+
1. Navigate to ``New`` > ``Folder``.
74
+
2. Click on ``Advanced``.
75
+
3. Select ``Link to alternate Location (Linked Folder)``.
76
+
4. Click ``Browse`` and select the ``ESP-IDF components`` folder.
75
77
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.
78
+
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 reside in the same workspace, you will still be able to search across your entire workspace.
77
79
78
80
If you have any issues with the Clangd Configuration with the LSP Editor, please refer to the :ref:`Clangd Configuration <clangd_cdt_support>` guide.
79
81
80
82
References
81
83
----------
84
+
82
85
.. toctree::
83
86
:maxdepth:1
84
87
85
88
Clangd CDT Support and Configuration <clangd_cdt_support>
Binary data can be written to the ESP’s flash chip via the *ESP-IDF > Write Binary Data to Flash* command. To access this command, right-click on the project in the Project Explorer:
4
+
:link_to_translation:`zh_CN:[中文]`
5
+
6
+
Binary data can be written to the ESP's flash chip via the ``ESP-IDF: Write Binary Data to Flash`` command. To access this command, right-click on the project in the Project Explorer:
After clicking this command, the *Write Binary Data to Flash* dialog box will open. Editable default values are provided for the binary path and offset. You can check the correct offset by viewing the partition table via *ESP-IDF > Partition Table Editor* or by manually opening the `partitions.csv` file.
11
+
After clicking this command, the ``Write Binary Data to Flash`` dialog box will open. Editable default values are provided for the binary path and offset. You can check the correct offset by viewing the partition table via ``ESP-IDF: Partition Table Editor`` or by manually opening the ``partitions.csv`` file.
0 commit comments