alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-22 17:02:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feat/add_idf_path_setting_info' into 'master'

Browse Source 
feat(tools): Add info message to install/export scripts about IDF_PATH being set/change.

Closes IDF-9355

See merge request espressif/esp-idf!34748
This commit is contained in:
Roland Dobai
2024-11-25 17:20:55 +08:00
parent 4110d14825 5182c8031e
commit a2c399c098
13 changed files with 39 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/api-guides/tools/idf-tools.rst
View File

@@ -184,9 +184,9 @@ Since the installed tools are not permanently added to the user or system ``PATH
.. note::
To modify the shell environment in Bash, ``export.sh`` must be "sourced" by using the ``. ./export.sh`` command. Please ensure to include the leading dot and space.
To modify the shell environment in Bash, ``export.sh`` must be "sourced" by using the command ``. ./export.sh``. Please ensure to include the leading dot and space.
``export.sh`` may be used with shells other than Bash (such as zsh). However, in this case, it is required to set the ``IDF_PATH`` environment variable before running the script. When used in Bash, the script guesses the ``IDF_PATH`` value from its own location.
``export.sh`` may be used with various shells like Bash, Zsh, sh, dash, etc. When using Bash or Zsh, you can run it from any path (e.g., ``. ./<<some_path>>/export.sh``) as it automatically detects ``IDF_PATH``. For other shells, it must be run from the ESP-IDF directory (``. ./export.sh``) to locate ``IDF_PATH`` correctly.
activate.py
~~~~~~~~~~~