From 01b3ffa8e34d4448b2bd4f014bc05cbeac1cd97d Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Fri, 10 Apr 2020 17:52:25 +0200 Subject: [PATCH] docs: remove suggestion about running export.sh from .profile script This was quite obviously a bad suggestion, and it seems that some users have actually read the docs attentively enough to have followed it. Replace be recommendation to create an alias. Closes https://github.com/espressif/esp-idf/issues/3889 --- docs/en/get-started/index.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/en/get-started/index.rst b/docs/en/get-started/index.rst index d31cb984d..d54fa4b0a 100644 --- a/docs/en/get-started/index.rst +++ b/docs/en/get-started/index.rst @@ -248,7 +248,13 @@ In the terminal where you are going to use ESP-IDF, run: Note the space between the leading dot and the path! -You can also automate this step, making ESP-IDF tools available in every terminal, by adding this line to your ``.profile`` or ``.bash_profile`` script. +You can also create an alias for the export script to your ``.profile`` or ``.bash_profile`` script. This way you can set up the environment in a new terminal window by typing ``get_idf``: + +.. code-block:: bash + + alias get_idf='. $HOME/esp/esp-idf/export.sh' + +Note that it is not recommended to source ``export.sh`` from the profile script directly. Doing so activates IDF virtual environment in every terminal session (even in those where IDF is not needed), defeating the purpose of the virtual environment and likely affecting other software. .. _get-started-start-project: