Skip to content

Commit f12788a

Browse files
committed
Reduce references to TOOLCHAINS
In preparation for new install swift documention recommending swiftly, this commit removes many references to the TOOLCHAINS env var used by xcrun which is no longer recommended.
1 parent aca95b2 commit f12788a

File tree

12 files changed

+5
-19
lines changed

12 files changed

+5
-19
lines changed

Sources/EmbeddedSwift/Documentation.docc/SDKSupport/IntegrateWithPico.md

-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ pico_add_extra_outputs(swift-blinky)
9595
With these three files, we can now configure and build a Swift firmware for the Pico:
9696

9797
```bash
98-
$ export TOOLCHAINS=org.swift.59202401301a
9998
$ export PICO_BOARD=pico
10099
$ export PICO_SDK_PATH=<path_to_pico_sdk>
101100
$ export PICO_TOOLCHAIN_PATH=<path_to_arm_toolchain>

esp32-led-blink-sdk/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,9 @@ This example demonstrates how to integrate with the ESP-IDF SDK via CMake and ho
1717

1818
- Make sure you have a recent nightly Swift toolchain that has Embedded Swift support.
1919
- If needed, run export.sh to get access to the idf.py script from ESP-IDF.
20-
- Specify the nightly toolchain to be used via the `TOOLCHAINS` environment variable and the target board type by using `idf.py set-target`.
20+
- Specify the target board type by using `idf.py set-target`.
2121
``` console
2222
$ cd esp32-led-blink-sdk
23-
$ export TOOLCHAINS=...
2423
$ . <path-to-esp-idf>/export.sh
2524
$ idf.py set-target esp32c6
2625
$ idf.py build

esp32-led-strip-sdk/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@ This example demonstrates how to integrate with the ESP-IDF SDK via CMake and ho
1616

1717
- Make sure you have a recent nightly Swift toolchain that has Embedded Swift support.
1818
- If needed, run export.sh to get access to the idf.py script from ESP-IDF.
19-
- Specify the nightly toolchain to be used via the `TOOLCHAINS` environment variable and the target board type by using `idf.py set-target`.
19+
- Specify and the target board type by using `idf.py set-target`.
2020
``` console
2121
$ cd esp32-led-strip-sdk
22-
$ export TOOLCHAINS=...
2322
$ . <path-to-esp-idf>/export.sh
2423
$ idf.py set-target esp32c6
2524
$ idf.py build

harmony/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ The firmware for Harmony is built using CMake and requires the Raspberry Pi Pico
5151

5252
3. Set the necessary environment variables:
5353
```bash
54-
export TOOLCHAINS='<toolchain-identifier>' # e.g., gcc-arm-none-eabi
5554
export PICO_BOARD=pico_w
5655
export PICO_SDK_PATH='<path-to-your-pico-sdk>' # e.g., ../pico-sdk
5756
export PICO_EXTRAS_PATH='<path-to-your-pico-extras>' # e.g., ../pico-extras

nrfx-blink-sdk/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,10 @@ This example demonstrates how to integrate with the Zephyr SDK via CMake and how
1919
## Building
2020

2121
- Make sure you have a recent nightly Swift toolchain that has Embedded Swift support.
22-
- Build the program in the Zephyr virtualenv, specify the nightly toolchain to be used via the `TOOLCHAINS` environment variable and the target board type via the `-DBOARD=...` CMake setting:
22+
- Build the program in the Zephyr virtualenv, specify the target board type via the `-DBOARD=...` CMake setting:
2323
``` console
2424
$ cd nrfx-blink-sdk
2525
$ source ~/zephyrproject/.venv/bin/activate
26-
(.venv) export TOOLCHAINS='<toolchain-identifier>'
2726
(.venv) cmake -B build -G Ninja -DBOARD=nrf52840dk_nrf52840 -DUSE_CCACHE=0 .
2827
(.venv) cmake --build build
2928
```

rpi-pico-blink-sdk/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ This example demonstrates how to integrate with the Pico SDK which is using CMak
2323

2424
``` console
2525
$ cd rpi-pico-blink-sdk
26-
$ export TOOLCHAINS='<toolchain-identifier>'
2726
$ export PICO_BOARD='<board-name>' # Examples: pico, pico2
2827
$ export PICO_PLATFORM='<optional-platform-name>' # Optional; useful if you'd like to compile for RISC-V. Examples: rp2040, rp2350-arm-s, rp2350-riscv
2928
$ export PICO_SDK_PATH='<path-to-your-pico-sdk>'

rpi-pico2-neopixel/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ index f6867b5..a2291db 100644
3737
- Build and copy the program in the UF2 format to the Mass Storage device to trigger flashing the program into memory (after which the device will reboot and run the firmware):
3838
``` console
3939
$ cd rpi-pico2-neopixel
40-
$ TOOLCHAINS='<toolchain-identifier>' make
40+
$ make
4141
$ cp .build/release/Application.uf2 /Volumes/RP2350
4242
```
4343
- The RGB LED should be animating through the color wheel.

rpi-picow-blink-sdk/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ This example demonstrates how to integrate with the Pico SDK which is using CMak
2222
- Build and copy the program in the UF2 format to the Mass Storage device to trigger flashing the program into memory (after which the device will reboot and run the firmware):
2323
``` console
2424
$ cd rpi-picow-blink-sdk
25-
$ export TOOLCHAINS='<toolchain-identifier>'
2625
$ export PICO_BOARD=pico_w
2726
$ export PICO_SDK_PATH='<path-to-your-pico-sdk>'
2827
$ export PICO_TOOLCHAIN_PATH='<path-to-the-arm-toolchain>'

stm32-blink/README.md

-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ This example shows a simple baremetal firmware for an STM32 board that blinks an
1515
- Build and upload the program to flash memory of the microcontroller:
1616
```console
1717
$ cd stm32-blink
18-
$ export TOOLCHAINS=$(plutil -extract CFBundleIdentifier raw /Library/Developer/Toolchains/swift-latest.xctoolchain/Info.plist)
1918
$ export STM_BOARD=STM32F746G_DISCOVERY # or NUCLEO_F103RB
2019
$ ./build-macho.sh
2120
$ st-flash --reset write .build/blink.bin 0x08000000
@@ -27,10 +26,6 @@ $ st-flash --reset write .build/blink.bin 0x08000000
2726
- Build and upload the program to flash memory of the microcontroller:
2827
```console
2928
$ cd stm32-blink
30-
31-
# If on macOS, select the right latest nightly toolchain (on Linux this is not needed):
32-
$ export TOOLCHAINS=$(plutil -extract CFBundleIdentifier raw /Library/Developer/Toolchains/swift-latest.xctoolchain/Info.plist)
33-
3429
$ export STM_BOARD=STM32F746G_DISCOVERY # or NUCLEO_F103RB
3530
$ ./build-elf.sh
3631
$ st-flash --format ihex --reset write .build/blink.hex

stm32-lcd-logo/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
- Build and upload the program to flash memory of the STM:
1111
```console
1212
$ cd stm32-lcd-logo
13-
$ TOOLCHAINS='<toolchain-identifier>' ./build.sh
13+
$ make
1414
$ st-flash --reset write .build/lcd-logo.bin 0x08000000
1515
```
1616
- The LCD display on the board should now be showing a bouncing animating Swift logo on a fading background, and the user LED on should be blinking.

stm32-neopixel/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ We recommend including a capacitor across the LED strip power supply.
2424
- Build and upload the program to flash memory of the STM:
2525
```console
2626
$ cd stm32-neopixel
27-
$ export TOOLCHAINS='<toolchain-identifier>'
2827
$ make
2928
$ st-flash --reset write .build/release/Application.bin 0x08000000
3029
```

stm32-uart-echo/README.md

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ $ screen /dev/cu.usbmodem<...> 115200
1414
- Build and upload the program to flash memory of the STM:
1515
```console
1616
$ cd stm32-uart-echo
17-
$ export TOOLCHAINS='<toolchain-identifier>'
1817
$ make
1918
$ st-flash --reset write .build/release/Application.bin 0x08000000
2019
```

0 commit comments

Comments
 (0)