-
Notifications
You must be signed in to change notification settings - Fork 121
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation for ESP-IDF Manager view and some minor fixes #953
Conversation
WalkthroughThe recent changes revolve around refining the installation process for ESP-IDF in the Espressif IDE, discarding outdated methods, and ushering in a new strategy for upcoming releases. These updates encompass detailed configuration and installation steps for ESP-IDF, the management of multiple versions, and the introduction of visual aids to enhance user comprehension. Furthermore, code modifications in Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 5
Out of diff range and nitpick comments (3)
README.md (3)
Line range hint
187-187
: Correct the contraction "it's" to "it is" for formal documentation.- ![](docs/images/icons/run.png) and it's auto-configured to flash the application with the default flash command i.e, `idf.py -p PORT flash`. + ![](docs/images/icons/run.png) and it is auto-configured to flash the application with the default flash command i.e., `idf.py -p PORT flash`.
Line range hint
408-408
: Add a comma for clarity.- Clang toolchain now is an experimental feature and you may face some build issues due to the incompatibility of esp-idf. + Clang toolchain now is an experimental feature, and you may face some build issues due to the incompatibility of esp-idf.
Line range hint
786-786
: Correct the phrase "right click" to "right-click".- Binary data can be written to the ESP’s flash chip via `ESP-IDF: Write Binary Data to Flash` command accessible by right click on the project in the project explorer: + Binary data can be written to the ESP’s flash chip via `ESP-IDF: Write Binary Data to Flash` command accessible by right-click on the project in the project explorer:
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (11)
docs/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png
is excluded by!**/*.png
docs/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png
is excluded by!**/*.png
docs/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png
is excluded by!**/*.png
docs/images/ToolsManager/Tool_installed_and_activated.png
is excluded by!**/*.png
docs/images/ToolsManager/git_python_selection.png
is excluded by!**/*.png
docs/images/ToolsManager/install_tools_manager.png
is excluded by!**/*.png
docs/images/ToolsManager/manage_tools_installation.png
is excluded by!**/*.png
docs/images/ToolsManager/select_or_download_new_esp_idf.png
is excluded by!**/*.png
docs/images/esp_idf_dir.png
is excluded by!**/*.png
docs/images/espidf_download.png
is excluded by!**/*.png
docs/images/install_tools.png
is excluded by!**/*.png
Files selected for processing (2)
- README.md (3 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java (2 hunks)
Files skipped from review due to trivial changes (1)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java
Additional Context Used
LanguageTool (53)
README.md (53)
Near line 17: This expression is usually spelled with a hyphen.
Context: ....png) > Note: It supports ESP-IDF CMake based projects (4.x and above). To get a qui...
Near line 75: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...
Near line 123: It seems that a comma is missing.
Context: ...alled and if it is configured in system PATH it will be preloaded in the given view....
Near line 123: It seems that a comma is missing.
Context: ...will be preloaded in the given view. If not you can Browse to the directory and sel...
Near line 130: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... in the IDE it will be activated as well and you will see a similar entry in the edi...
Near line 133: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want but only one of ...
Near line 133: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...d as many version of ESP-IDF as you want but only one of the version can be set acti...
Near line 133: Did you mean “versions”?
Context: ...ESP-IDF as you want but only one of the version can be set active and that will be used...
Near line 134: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...ween versions in the workspace easily. Lets take a look at how the multiple version...
Near line 135: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ... workspace easily. Lets take a look at how the multiple versions will look like. You have to follow the same steps as d...
Near line 142: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...made. > Note Please note that you can not delete an active ESP-IDF Version you ne...
Near line 178: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode
. 1. Select your application from the second drop-d...
Near line 179: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...aunch Configuration`(Auto-detected). 1. Select a target from the third drop-down, whic...
Near line 187: This word is normally spelled as one.
Context: ... and it's auto-configured to flash the application with the defau...
Near line 225: Possible missing comma found.
Context: ...ew for the new debug configuration will open where it's necessary to check the board...
Near line 240: Two consecutive dots
Context: ...pective fromWindow
>Perspective
>Reset Perspective..
). 1. Provide theProject name
. 1. Cl...
Near line 247: Possible missing comma found.
Context: ...t of unresolved inclusion errors in the editor and those will be resolved only after t...
Near line 318: Possible missing comma found.
Context: ... in which you want to add the component to and SelectInstall ESP-IDF Components
...
Near line 327: Possible missing comma found.
Context: ... Already added components are also shown but theInstall
button changes text to `A...
Near line 372: Two consecutive dots
Context: ...oolchainspreference page. 1. Click on
Add..` from the user-defined toolchains table...
Near line 393: The word “hence” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...e CDT has a bug in saving the toolchain preferences, hence it's recommended to restart Eclipse bef...
Near line 408: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...toolchain now is an experimental feature and you may face some build issues due to t...
Near line 408: Consider adding a comma here.
Context: ...irty). To work around clang build errors please refer to [this](https://github.com/espr...
Near line 431: Possible missing comma found.
Context: ...Changing Language To change the plugin language a menu is provided to show the list of ...
Near line 436: Possible missing article found.
Context: ... you want. 1. Eclipse will restart with selected language. ![](docs/images/change_langu...
Near line 439: Possible missing comma found.
Context: ... Remember this will only change the language of t...
Near line 448: Consider a more expressive alternative.
Context: ... you can still use the hints viewer. To do it, you have to manually download the h...
Near line 449: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...heRaw
button and thenSave as...
. To open the hints viewer go toWindows
-...
Near line 450: Possible missing comma found.
Context: ...d thenSave as...
. To open the hints viewer go toWindows
->Show View
-> `Othe...
Near line 453: Did you mean “copy and paste”?
Context: ...-79af28c50c55.png) Now you can type or copy paste some error from the build log, for exam...
Near line 548: Two consecutive dots
Context: ...ck in theProject Explorer
. 1. SelectImport..
Menu. 1. SelectExisting IDF Project
...
Near line 568: Possible missing comma found.
Context: ...an existing configuration with the same name then select `Overwrite existing launch ...
Near line 568: ‘without warning’ might be wordy. Consider a shorter alternative.
Context: ...guration with the same name then selectOverwrite existing launch configurations without warning
. 1. Click onFinish
. <a name="gdbSt...
Near line 578: Possible missing comma found.
Context: ...` in project root by double-clicking on it which will open the configuration edito...
Near line 607: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ted. Remember that this is a panic mode and you cannot continue the execution from ...
Near line 619: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...he chip and the configurations are set. Currently only the UART core dump capture and deb...
Near line 651: The preposition ‘of’ seems more likely in this position.
Context: ...be in bootloader mode for the detection as a DFU device and flashing. This can be ...
Near line 654: Consider using a different verb to strengthen your wording.
Context: ...ool](https://zadig.akeo.ie/). - Please make sure that the device is in download mode bef...
Near line 675: Consider a shorter alternative to avoid wordiness.
Context: ...you must select the board you are using in order to successfully start the OpenOCD server. ...
Near line 683: This word is normally spelled as one.
Context: ...plication-level trace dialog, there are auto-configured fields that you can change for the trac...
Near line 690: Loose punctuation mark.
Context: ...file://path/to/file``. *
poll_period`: Data polling period (in ms) for availab...
Near line 690: Consider adding a comma.
Context: ... available trace data. If greater than 0 then command runs in non-blocking mode. By d...
Near line 691: Loose punctuation mark.
Context: ... mode. By default, 1 ms. *trace_size
: Maximum size of data to collect (in byt...
Near line 692: Loose punctuation mark.
Context: ...stop trigger is disabled). *stop_tmo
: Idle timeout (in sec). Tracing is stopp...
Near line 693: Loose punctuation mark.
Context: ...commands from the target. *wait4halt
: If 0 start tracing immediately, otherwi...
Near line 694: Loose punctuation mark.
Context: ...s tracing. By default, 0. *skip_size
: Number of bytes to skip at the start. B...
Near line 704: Possible missing comma found.
Context: .../trace/file/path/to/program/elf/file. Note the
Start parse` button is disabled un...
Near line 723: Did you mean “editing”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ... Partition Table Editor` command allows to edit your [partition table](https://docs.esp...
Near line 749: This expression is usually spelled with a hyphen.
Context: ...th NVS architecture defined in [ESP_IDF Non Volatile Storage](https://docs.espressif.com/pro...
Near line 786: Possible missing comma found.
Context: ...aESP-IDF: Write Binary Data to Flash
command accessible by right click on the projec...
Near line 786: The verb “right-click” is spelled with a hyphen.
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...
Near line 794: This phrase is redundant. Consider using “inside”.
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...
Near line 819: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en tick mark. 1. Click onDetails
. 1. Click onSummary
on the left. 1. Scroll dow...
… for non active esp-idf versions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 5
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (11)
docs/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png
is excluded by!**/*.png
docs/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.png
is excluded by!**/*.png
docs/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.png
is excluded by!**/*.png
docs/images/ToolsManager/Tool_installed_and_activated.png
is excluded by!**/*.png
docs/images/ToolsManager/git_python_selection.png
is excluded by!**/*.png
docs/images/ToolsManager/install_tools_manager.png
is excluded by!**/*.png
docs/images/ToolsManager/manage_tools_installation.png
is excluded by!**/*.png
docs/images/ToolsManager/select_or_download_new_esp_idf.png
is excluded by!**/*.png
docs/images/esp_idf_dir.png
is excluded by!**/*.png
docs/images/espidf_download.png
is excluded by!**/*.png
docs/images/install_tools.png
is excluded by!**/*.png
Files selected for processing (2)
- README.md (3 hunks)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/manager/pages/ESPIDFMainTablePage.java
Additional Context Used
LanguageTool (61)
README.md (61)
Near line 17: This expression is usually spelled with a hyphen.
Context: ....png) > Note: It supports ESP-IDF CMake based projects (4.x and above). To get a qui...
Near line 75: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...
Near line 114: Possible missing article found.
Context: ... moving forward with this approach from next stable release. Please follow the inst...
Near line 123: It seems that a comma is missing.
Context: ...alled and if it is configured in system PATH it will be preloaded in the given view....
Near line 123: It seems that a comma is missing.
Context: ...will be preloaded in the given view. If not you can Browse to the directory and sel...
Near line 130: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... in the IDE it will be activated as well and you will see a similar entry in the edi...
Near line 133: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”.
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want but only one of ...
Near line 133: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...d as many version of ESP-IDF as you want but only one of the version can be set acti...
Near line 133: Did you mean “versions”?
Context: ...ESP-IDF as you want but only one of the version can be set active and that will be used...
Near line 135: ‘Like’ cannot be used with the question word ‘how’ in this context.
Context: ... workspace easily. Lets take a look at how the multiple versions will look like. You have to follow the same steps as d...
Near line 142: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...made. > Note Please note that you can not delete an active ESP-IDF Version you ne...
Near line 178: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...down, which is calledLaunch Mode
. 1. Select your application from the second drop-d...
Near line 179: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...aunch Configuration`(Auto-detected). 1. Select a target from the third drop-down, whic...
Near line 187: This word is normally spelled as one.
Context: ... and it's auto-configured to flash the application with the defau...
Near line 240: Two consecutive dots
Context: ...pective fromWindow
>Perspective
>Reset Perspective..
). 1. Provide theProject name
. 1. Cl...
Near line 318: Possible missing comma found.
Context: ... in which you want to add the component to and SelectInstall ESP-IDF Components
...
Near line 324: Possible missing comma found.
Context: ...ect. To get to the readme file for that component you can click onMore Info
which will...
Near line 327: Possible missing comma found.
Context: ... Already added components are also shown but theInstall
button changes text to `A...
Near line 372: Two consecutive dots
Context: ...oolchainspreference page. 1. Click on
Add..` from the user-defined toolchains table...
Near line 393: The word “hence” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...e CDT has a bug in saving the toolchain preferences, hence it's recommended to restart Eclipse bef...
Near line 408: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...toolchain now is an experimental feature and you may face some build issues due to t...
Near line 408: Consider adding a comma here.
Context: ...irty). To work around clang build errors please refer to [this](https://github.com/espr...
Near line 431: Possible missing comma found.
Context: ...Changing Language To change the plugin language a menu is provided to show the list of ...
Near line 436: Possible missing article found.
Context: ... you want. 1. Eclipse will restart with selected language. ![](docs/images/change_langu...
Near line 439: Possible missing comma found.
Context: ... Remember this will only change the language of t...
Near line 448: Consider a more expressive alternative.
Context: ... you can still use the hints viewer. To do it, you have to manually download the h...
Near line 449: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...heRaw
button and thenSave as...
. To open the hints viewer go toWindows
-...
Near line 450: Possible missing comma found.
Context: ...d thenSave as...
. To open the hints viewer go toWindows
->Show View
-> `Othe...
Near line 453: Did you mean “copy and paste”?
Context: ...-79af28c50c55.png) Now you can type or copy paste some error from the build log, for exam...
Near line 548: Two consecutive dots
Context: ...ck in theProject Explorer
. 1. SelectImport..
Menu. 1. SelectExisting IDF Project
...
Near line 568: Possible missing comma found.
Context: ...an existing configuration with the same name then select `Overwrite existing launch ...
Near line 568: ‘without warning’ might be wordy. Consider a shorter alternative.
Context: ...guration with the same name then selectOverwrite existing launch configurations without warning
. 1. Click onFinish
. <a name="gdbSt...
Near line 578: Possible missing comma found.
Context: ...` in project root by double-clicking on it which will open the configuration edito...
Near line 607: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ted. Remember that this is a panic mode and you cannot continue the execution from ...
Near line 611: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...debug_panic_mode.png) You can view the registers stack trace and even view the value of ...
Near line 613: Possible missing comma found.
Context: ... in the stack frame. To exit the debug session simply pressstop
button. <a name="c...
Near line 619: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...he chip and the configurations are set. Currently only the UART core dump capture and deb...
Near line 623: Possible missing comma found.
Context: ... the project root by double-clicking on it which will open the configuration edito...
Near line 651: The preposition ‘of’ seems more likely in this position.
Context: ...be in bootloader mode for the detection as a DFU device and flashing. This can be ...
Near line 654: Consider using a different verb to strengthen your wording.
Context: ...ool](https://zadig.akeo.ie/). - Please make sure that the device is in download mode bef...
Near line 675: Possible missing comma found.
Context: ...to create a debug configuration for the project where you must select the board you are...
Near line 675: Consider a shorter alternative to avoid wordiness.
Context: ...you must select the board you are using in order to successfully start the OpenOCD server. ...
Near line 683: This word is normally spelled as one.
Context: ...plication-level trace dialog, there are auto-configured fields that you can change for the trac...
Near line 690: Loose punctuation mark.
Context: ...file://path/to/file``. *
poll_period`: Data polling period (in ms) for availab...
Near line 690: Consider adding a comma.
Context: ... available trace data. If greater than 0 then command runs in non-blocking mode. By d...
Near line 690: Possible missing article found.
Context: ...able trace data. If greater than 0 then command runs in non-blocking mode. By default, ...
Near line 691: Loose punctuation mark.
Context: ... mode. By default, 1 ms. *trace_size
: Maximum size of data to collect (in byt...
Near line 691: Possible missing comma found.
Context: ...pecified amount of data is received. By default -1 (trace size stop trigger is disabled...
Near line 692: Loose punctuation mark.
Context: ...stop trigger is disabled). *stop_tmo
: Idle timeout (in sec). Tracing is stopp...
Near line 693: Loose punctuation mark.
Context: ...commands from the target. *wait4halt
: If 0 start tracing immediately, otherwi...
Near line 694: Loose punctuation mark.
Context: ...s tracing. By default, 0. *skip_size
: Number of bytes to skip at the start. B...
Near line 704: Possible missing comma found.
Context: .../trace/file/path/to/program/elf/file. Note the
Start parse` button is disabled un...
Near line 723: Did you mean “editing”? Or maybe you should add a pronoun? In active voice, ‘allow’ + ‘to’ takes an object, usually a pronoun.
Context: ... Partition Table Editor` command allows to edit your [partition table](https://docs.esp...
Near line 749: This expression is usually spelled with a hyphen.
Context: ...th NVS architecture defined in [ESP_IDF Non Volatile Storage](https://docs.espressif.com/pro...
Near line 773: Possible missing comma found.
Context: ...binary (Chooseencrypt
to encrypt the binary and disable the generate key option to ...
Near line 786: Possible missing comma found.
Context: ...aESP-IDF: Write Binary Data to Flash
command accessible by right click on the projec...
Near line 786: The verb “right-click” is spelled with a hyphen.
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...
Near line 794: This phrase is redundant. Consider using “inside”.
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...
Near line 819: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...en tick mark. 1. Click onDetails
. 1. Click onSummary
on the left. 1. Scroll dow...
Near line 829: Possible missing comma found.
Context: ...onfigurationEdit
button from the top toolbar and this will the launch `Edit Configur...
Near line 831: Possible missing article found.
Context: ...tom build path>` with an absolute path. Customized build directory path could be within th...
@@ -112,42 +111,35 @@ For adding beta and nightly builds, you can use the following update site urls. | |||
<a name="InstallTools"></a> | |||
# Installing ESP-IDF | |||
|
|||
To install ESP-IDF directly from the Eclipse: | |||
>With release of the beata 3.0 all the old installation flows for the ESP-IDF are now closed. We will be moving forward with this approach from next stable release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct the typo in "beata 3.0" to "beta 3.0".
- With release of the beata 3.0 all the old installation flows for the ESP-IDF are now closed.
+ With release of the beta 3.0 all the old installation flows for the ESP-IDF are now closed.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
>With release of the beata 3.0 all the old installation flows for the ESP-IDF are now closed. We will be moving forward with this approach from next stable release. | |
>With release of the beta 3.0 all the old installation flows for the ESP-IDF are now closed. We will be moving forward with this approach from next stable release. |
![](docs/images/espidf_download.png) | ||
1. Click on `Add ESP-IDF` button. | ||
![](docs/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.png) | ||
From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add missing commas for clarity.
- The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view.
+ The `Git` and `Python` must be installed, and if it is configured in system PATH, it will be preloaded in the given view.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed and if it is configured in system PATH it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables. | |
From the screen shown above you can choose an already downloaded ESP-IDF Directory or you can select and download directly from the given dialog. The `Git` and `Python` must be installed, and if it is configured in system PATH, it will be preloaded in the given view. If not you can Browse to the directory and select the proper executables. |
1. Provide `Git` and `Python` executable locations if they are not auto-detected. | ||
1. Click on `Install Tools` to proceed with the installation process. Check the Console for the installation details. | ||
1. Installation might take a while if you're doing it for the first time since it has to download and install `xtensa-esp32-elf`, `esp32ulp-elf`, Cmake, `openocd-esp32` and Ninja tools. | ||
You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct the phrase "look like" to "look".
- Lets take a look at how the multiple versions will look like.
+ Let's take a look at how the multiple versions will look.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
Let's take a look at how the multiple versions will look. |
|
||
![](docs/images/esp_idf_dir.png) | ||
> **Note** Please note that you can not delete an active ESP-IDF Version you need to activate another version before deleting that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change "can not" to "cannot" for better readability.
- > **Note** Please note that you can not delete an active ESP-IDF Version you need to activate another version before deleting that.
+ > **Note** Please note that you cannot delete an active ESP-IDF Version; you need to activate another version before deleting that.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
> **Note** Please note that you can not delete an active ESP-IDF Version you need to activate another version before deleting that. | |
> **Note** Please note that you cannot delete an active ESP-IDF Version; you need to activate another version before deleting that. |
1. Provide `Git` and `Python` executable locations if they are not auto-detected. | ||
1. Click on `Install Tools` to proceed with the installation process. Check the Console for the installation details. | ||
1. Installation might take a while if you're doing it for the first time since it has to download and install `xtensa-esp32-elf`, `esp32ulp-elf`, Cmake, `openocd-esp32` and Ninja tools. | ||
You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct grammatical error: change "many version" to "many versions".
- You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace.
+ You can add as many versions of ESP-IDF as you want, but only one of the versions can be set active and that will be used to compile and index projects in your workspace.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
You can add as many version of ESP-IDF as you want but only one of the version can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. | |
You can add as many versions of ESP-IDF as you want, but only one of the versions can be set active and that will be used to compile and index projects in your workspace. This new feature can help you in swithcing between versions in the workspace easily. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
doc changes and changes to the last column to only show delete button for non active esp-idf versions.
Fixes # (IEP-1233)
Type of change
Please delete options that are not relevant.
Documentation and minor UI change
Checklist
Summary by CodeRabbit
Documentation
New Features