From 6cc597151683b77bab5d0cefec34b9c06f321240 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Thu, 17 May 2018 14:08:31 +0800 Subject: [PATCH] docs: Add some clarification about ~/.profile --- docs/en/get-started/add-idf_path-to-profile.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/en/get-started/add-idf_path-to-profile.rst b/docs/en/get-started/add-idf_path-to-profile.rst index f775f901f..5ba2fad5b 100644 --- a/docs/en/get-started/add-idf_path-to-profile.rst +++ b/docs/en/get-started/add-idf_path-to-profile.rst @@ -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::