alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 12:35:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(tools): Inform user about IDF_PATH set/change in install/export scripts

Browse Source
This commit is contained in:
Marek Fiala
2024-11-07 10:46:50 +01:00
committed by BOT
parent ab3d179f53
commit cad15b50c4
12 changed files with 37 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -184,7 +184,7 @@ Since the installed tools are not permanently added to the user or system ``PATH
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.
``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
~~~~~~~~~~~