Merge branch 'feat/add_idf_path_setting_info' into 'master'

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
13 changed files with 39 additions and 21 deletions

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
~~~~~~~~~~~

View File

@@ -186,7 +186,7 @@ ESP-IDF 的根目录中提供了针对不同 shell 的用户安装脚本,包
在 Bash 中修改 shell 环境时,必须使用 ``. ./export.sh`` 命令加载 ``export.sh``,注意添加前面的点和空格。
``export.sh`` 可以在除了 Bash 外的其他 shell如 zsh中使用。但在这种情况下必须在运行脚本前设置 ``IDF_PATH`` 环境变量。在 Bash 中使用时,脚本会从当前目录猜测 ``IDF_PATH`` 的值。
``export.sh`` 可以在多种 shell 中使用,例如 bash、sh、zsh、dash 等。在使用 bash 或 zsh 时,可以在任何路径中直接运行(例如 ``. ./<<some_path>>/export.sh``),这是因为它能够自动检测到 ``IDF_PATH``。若使用其它 shell, 则必须在 ESP-IDF 路径中运行 (``. ./export.sh``),才能正确找到 ``IDF_PATH``
activate.py
~~~~~~~~~~~