cpu/esp*: update documentation of esptools

RIOT-OS · Jan 9, 2025 · efe9785 · efe9785
1 parent 2959725
commit efe9785
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/cpu/esp32/doc.txt b/cpu/esp32/doc.txt
@@ -486,7 +486,7 @@ toolchain (Debian/Ubuntu package names):
 The shell script `$RIOTBASE/dist/tools/esptools/install.sh` is used to
 install Espressif's precompiled versions of the following tools:
 
-- ESP32 vendor toolchain (for ESP32, ESP32-S2, ESP32-S3 and ESP32-C3)
+- ESP32 vendor toolchain (for ESP8266, ESP32, ESP32-S2, ESP32-S3 and ESP32-C3)
 - GDB for ESP32x SoCs based on Xtensa or RISC-V
 - OpenOCD for ESP32 (for ESP32, ESP32-S2, ESP32-S3 and ESP32-C3)
 - QEMU for ESP32 (only for ESP32)
@@ -499,7 +499,7 @@ $ dist/tools/esptools/install.sh
 
 Usage: install.sh <tool>
        install.sh gdb <platform>
-<tool> = all | esp32 | esp32c3 | esp32s2 | esp32s3 | gdb | openocd | qemu
+<tool> = all | esp8266 | esp32 | esp32c3 | esp32s2 | esp32s3 | gdb | openocd | qemu
 <platform> = xtensa | riscv
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/cpu/esp8266/doc.txt b/cpu/esp8266/doc.txt
@@ -308,7 +308,7 @@ system using the `BUILD_IN_DOCKER` variable:
 
 ## Manual Toolchain Installation {#esp8266_manual_toolchain_installation}
 
-A more difficult way to install the toolchain is the manual installation of
+A more simple way to install the toolchain is the manual installation of
 all required components as described below.
 
 @note To install the toolchain manually, a 64-bit Linux system is required.
@@ -325,17 +325,18 @@ The Xtensa GCC compiler for ESP8266 configured for use with RIOT-OS can
 be downloaded and installed as precompiled binary archive from
 [GitHub](https://github.com/gschorcht/xtensa-esp8266-elf):
 
+The shell script `$RIOTBASE/dist/tools/esptools/install.sh` is used to
+install the custom ESP8266 toolchain:
+
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-mkdir -p $HOME/esp
-cd $HOME/esp
-git clone https://github.com/gschorcht/xtensa-esp8266-elf
+$ dist/tools/esptools/install.sh esp8266
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Once the compiler is installed, you have to expand your `PATH` variable by
 the directory with Xtensa GCC binaries:
 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-export PATH=$HOME/esp/xtensa-esp8266-elf/bin:$PATH
+$ . dist/tools/esptools/export.sh esp8266
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 [Back to table of contents](#esp8266_toc)