mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
docs: Mark some more docs sections as ESP32 only
This commit is contained in:
parent
e753c1b509
commit
b0748b4364
@ -182,7 +182,8 @@ def update_exclude_patterns(tags):
|
|||||||
'api-guides/ulp-legacy.rst',
|
'api-guides/ulp-legacy.rst',
|
||||||
'api-guides/unit-tests-legacy.rst',
|
'api-guides/unit-tests-legacy.rst',
|
||||||
'api-reference/bluetooth/**',
|
'api-reference/bluetooth/**',
|
||||||
'get-started-legacy/**']:
|
'get-started-legacy/**',
|
||||||
|
'gnu-make-legacy.rst']:
|
||||||
exclude_patterns.append(e)
|
exclude_patterns.append(e)
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
|
@ -70,7 +70,33 @@ Build the toolchain::
|
|||||||
./ct-ng build
|
./ct-ng build
|
||||||
chmod -R u+w builds/xtensa-esp32-elf
|
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 <setup-linux-toolchain-add-it-to-path-legacy>` 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
|
Next Steps
|
||||||
|
@ -44,7 +44,7 @@ Related Documents
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
linux-setup-scratch
|
:esp32: linux-setup-scratch
|
||||||
|
|
||||||
|
|
||||||
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
|
||||||
|
@ -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 <eclipse-setup>` or another graphical IDE with CMake support instead.
|
For this Getting Started we're going to use the Command Prompt, but after ESP-IDF is installed you can use :doc:`Eclipse <eclipse-setup>` or another graphical IDE with CMake support instead.
|
||||||
|
|
||||||
.. only:: esp32
|
.. only:: esp32
|
||||||
|
|
||||||
.. note::
|
.. 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.
|
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.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user