From b0748b4364e802b45a030de3aba0d99713ac9683 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Tue, 26 Nov 2019 17:22:50 +1100 Subject: [PATCH] docs: Mark some more docs sections as ESP32 only --- docs/conf_common.py | 3 ++- docs/en/get-started/linux-setup-scratch.rst | 28 ++++++++++++++++++++- docs/en/get-started/linux-setup.rst | 2 +- docs/en/get-started/windows-setup.rst | 1 + 4 files changed, 31 insertions(+), 3 deletions(-) diff --git a/docs/conf_common.py b/docs/conf_common.py index ee80513fd..c30c5e7a7 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -182,7 +182,8 @@ def update_exclude_patterns(tags): 'api-guides/ulp-legacy.rst', 'api-guides/unit-tests-legacy.rst', 'api-reference/bluetooth/**', - 'get-started-legacy/**']: + 'get-started-legacy/**', + 'gnu-make-legacy.rst']: exclude_patterns.append(e) # The reST default role (used for this markup: `text`) to use for all diff --git a/docs/en/get-started/linux-setup-scratch.rst b/docs/en/get-started/linux-setup-scratch.rst index d7f8c7d11..361b54499 100644 --- a/docs/en/get-started/linux-setup-scratch.rst +++ b/docs/en/get-started/linux-setup-scratch.rst @@ -70,7 +70,33 @@ Build the toolchain:: ./ct-ng build chmod -R u+w builds/xtensa-esp32-elf -Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup ` to add the toolchain to your ``PATH``. +Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. + +Add Toolchain to PATH +===================== + +The custom toolchain needs to be copied to a binary directory and added to the ``PATH``. + +Choose a directory, for example ``~/esp/xtensa-esp32-elf/``, and copy the build output to this directory. + +To use it, you will need to update your ``PATH`` environment variable in ``~/.profile`` file. To make ``xtensa-esp32-elf`` available for all terminal sessions, add the following line to your ``~/.profile`` file:: + + export PATH="$HOME/esp/xtensa-esp32-elf/bin:$PATH" + +.. note:: + + If you have ``/bin/bash`` set as login shell, and both ``.bash_profile`` and ``.profile`` exist, then update ``.bash_profile`` instead. In CentOS, ``alias`` should set in ``.bashrc``. + +Log off and log in back to make the ``.profile`` changes effective. Run the following command to verify if ``PATH`` is correctly set:: + + printenv PATH + +You are looking for similar result containing toolchain's path at the beginning of displayed string:: + + $ printenv PATH + /home/user-name/esp/xtensa-esp32-elf/bin:/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 + +Instead of ``/home/user-name`` there should be a home path specific to your installation. Next Steps diff --git a/docs/en/get-started/linux-setup.rst b/docs/en/get-started/linux-setup.rst index eae5821b4..e647b7976 100644 --- a/docs/en/get-started/linux-setup.rst +++ b/docs/en/get-started/linux-setup.rst @@ -44,7 +44,7 @@ Related Documents .. toctree:: :maxdepth: 1 - linux-setup-scratch + :esp32: linux-setup-scratch .. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository diff --git a/docs/en/get-started/windows-setup.rst b/docs/en/get-started/windows-setup.rst index 6593bde3b..e617ddedb 100644 --- a/docs/en/get-started/windows-setup.rst +++ b/docs/en/get-started/windows-setup.rst @@ -17,6 +17,7 @@ ESP-IDF requires some prerequisite tools to be installed so you can build firmwa For this Getting Started we're going to use the Command Prompt, but after ESP-IDF is installed you can use :doc:`Eclipse ` or another graphical IDE with CMake support instead. .. only:: esp32 + .. note:: Previous versions of ESP-IDF used the :doc:`Legacy GNU Make Build System<../get-started-legacy/windows-setup>` and MSYS2_ Unix compatibility environment. This is no longer required, ESP-IDF can be used from the Windows Command Prompt.