]> granicus.if.org Git - esp-idf/commitdiff
docs: Add some clarification about ~/.profile
authorAngus Gratton <angus@espressif.com>
Thu, 17 May 2018 06:08:31 +0000 (14:08 +0800)
committerAngus Gratton <gus@projectgus.com>
Tue, 29 May 2018 06:34:45 +0000 (16:34 +1000)
docs/en/get-started/add-idf_path-to-profile.rst

index f775f901f95bee5e31466a594c7bb2529414205c..5ba2fad5bc21f409222723c99be91e0986514588 100644 (file)
@@ -39,16 +39,20 @@ If you got here from section :ref:`get-started-setup-path`, while installing s/w
 Linux and MacOS
 ---------------
 
-Set up ``IDF_PATH`` and add ``idf.py`` to the PATH by adding the following two lines to ``~/.profile`` file::
+Set up ``IDF_PATH`` and add ``idf.py`` to the PATH by adding the following two lines to your ``~/.profile`` file::
 
     export IDF_PATH=~/esp/esp-idf
     export PATH="$PATH:$IDF_PATH/tools"
 
+.. note::
+
+   ``~/.profile`` means a file named ``.profile`` in your user's home directory (which is abbreviated ``~`` in the shell).
+
 Log off and log in back to make this change effective.
 
 .. note::
 
-    If you have ``/bin/bash`` set as login shell, and both ``.bash_profile`` and ``.profile`` exist, then update ``.bash_profile`` instead.
+    Not all shells use ``.profile``. If you have ``/bin/bash`` and ``.bash_profile`` exists then update this file instead. For ``zsh``, update ``.zprofile``. Other shells may use other profile files (consult the shell's documentation).
 
 Run the following command to check if ``IDF_PATH`` is set::