From: krzychb <krzychb@gazeta.pl>
Date: Wed, 24 May 2017 05:00:43 +0000 (+0200)
Subject: Small fixes/updates to toolchain installation procedures
X-Git-Tag: v2.1-rc1~87^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d12f871be6877f638c0826cdaedd7aa74aa41ab7;p=esp-idf

Small fixes/updates to toolchain installation procedures
---

diff --git a/docs/_static/msys2-terminal-window.png b/docs/_static/msys2-terminal-window.png
index a748ae8f97..d33d9dea1a 100644
Binary files a/docs/_static/msys2-terminal-window.png and b/docs/_static/msys2-terminal-window.png differ
diff --git a/docs/get-started/linux-setup.rst b/docs/get-started/linux-setup.rst
index db4182ac73..5e43ea3254 100644
--- a/docs/get-started/linux-setup.rst
+++ b/docs/get-started/linux-setup.rst
@@ -1,4 +1,4 @@
-*************************************
+*************************************
 Standard Setup of Toolchain for Linux
 *************************************
 
@@ -34,25 +34,36 @@ ESP32 toolchain for Linux is available for download from Espressif website:
 
   https://dl.espressif.com/dl/xtensa-esp32-elf-linux32-1.22.0-61-gab8375a-5.2.0.tar.gz
 
-Download this file, then extract it in ``~/esp`` directory::
+1.  Download this file, then extract it in ``~/esp`` directory::
 
-    mkdir -p ~/esp
-    cd ~/esp
-    tar -xzf ~/Downloads/xtensa-esp32-elf-linux64-1.22.0-61-gab8375a-5.2.0.tar.gz
+        mkdir -p ~/esp
+        cd ~/esp
+        tar -xzf ~/Downloads/xtensa-esp32-elf-linux64-1.22.0-61-gab8375a-5.2.0.tar.gz
 
 .. _setup-linux-toolchain-add-it-to-path:
 
-The toolchain will be extracted into ``~/esp/xtensa-esp32-elf/`` directory.
+2.  The toolchain will be extracted into ``~/esp/xtensa-esp32-elf/`` directory.
+
+    To use it, you will need to update your ``PATH`` environment variable in ``~/.bash_profile`` file. To make ``xtensa-esp32-elf`` available for all terminal sessions, add the following line to your ``~/.bash_profile`` file::
+
+        export PATH=$PATH:$HOME/esp/xtensa-esp32-elf/bin
+
+    Alternatively, you may create an alias for the above command. This way you can get the toolchain only when you need it. To do this, add different line to your ``~/.bash_profile`` file::
+
+        alias get_esp32="export PATH=$PATH:$HOME/esp/xtensa-esp32-elf/bin"
+
+    Then when you need the toolchain you can type ``get_esp32`` on the command line and the toolchain will be added to your ``PATH``.
 
-To use it, you will need to update your ``PATH`` environment variable in ``~/.bash_profile`` file. To make ``xtensa-esp32-elf`` available for all terminal sessions, add the following line to your ``~/.bash_profile`` file::
+3.  Finally, run the following command to verify if ``PATH`` is correctly set::
 
-    export PATH=$PATH:$HOME/esp/xtensa-esp32-elf/bin
+        printenv PATH
 
-Alternatively, you may create an alias for the above command. This way you can get the toolchain only when you need it. To do this, add different line to your ``~/.bash_profile`` file::
+    You are looking for similar result containing toolchain's path at the end of displayed string::
 
-    alias get_esp32="export PATH=$PATH:$HOME/esp/xtensa-esp32-elf/bin"
+        $ printenv PATH
+        /home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/home/user-name/esp/xtensa-esp32-elf/bin
 
-Then when you need the toolchain you can type ``get_esp32`` on the command line and the toolchain will be added to your ``PATH``.
+    Instead of ``/home/user-name`` there should be a home path specific to your installation.
 
 
 Arch Linux Users
diff --git a/docs/get-started/windows-setup.rst b/docs/get-started/windows-setup.rst
index 4abd3272a0..6d4a5ab3fd 100644
--- a/docs/get-started/windows-setup.rst
+++ b/docs/get-started/windows-setup.rst
@@ -21,14 +21,14 @@ Unzip the zip file to ``C:\`` (or some other location, but this guide assumes ``
 Check it Out
 ============
 
-Open an MSYS2 terminal window by running ``C:\msys32\mingw32.exe``. The environment in this window is a bash shell. 
+Open a MSYS2 MINGW32 terminal window by running ``C:\msys32\mingw32.exe``. The environment in this window is a bash shell. 
 
 .. figure:: ../_static/msys2-terminal-window.png
     :align: center
-    :alt: MSYS2 terminal window
+    :alt: MSYS2 MINGW32 shell window
     :figclass: align-center
 
-    MSYS2 terminal window
+    MSYS2 MINGW32 shell window
 
 Use this window in the following steps setting up development environment for ESP32.