Skip to content

Commit 0de1fc1

Browse files
Fix dead links to WIP articles (#158)
1 parent 2b37be6 commit 0de1fc1

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

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

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,12 @@ Using a bridging header is discouraged when building an entire set of Swift libr
3737

3838
Most embedded platforms use one of these build systems:
3939

40-
1. **CMake** - See <doc:IntegrateWithCMake> for details
41-
2. **Make** - See <doc:IntegrateWithMake> for more information
42-
3. **Platform-specific build tools** - These usually allow integration of custom build steps, and you can always manually invoke the Swift compiler (`swiftc`) with the right flags to produce a .o file that can be further used in the build. Follow the <doc:Basics> article for details.
40+
1. **CMake**.
41+
2. **Make**.
42+
3. **Platform-specific build tools** - These usually allow integration of custom build steps.
43+
44+
For (1) and (2), articles will be added to this documentation in the future.
45+
For (3), it is always possible to manually invoke the Swift compiler (`swiftc`) with the right flags to produce a .o file that can be further used in the build system. Follow the <doc:Basics> article for details.
4346

4447
### Matching platform's ISA and ABI
4548

@@ -66,7 +69,9 @@ For detailed instructions on integrating with the Raspberry Pi Pico SDK, see <do
6669

6770
### ESP32
6871

69-
For ESP microcontrollers using the ESP-IDF framework, see <doc:IntegrateWithESP>. Note that only chips based on RISC-V architecture (e.g. ESP32-C3, ESP32-C6, ESP32-P4) are supported with Embedded Swift. The Xtensa ISA (used in e.g. ESP8266 or ESP32-S2 and ESP32-S3) is not supported.
72+
Note that only chips based on RISC-V architecture (e.g. ESP32-C3, ESP32-C6, ESP32-P4) are supported with Embedded Swift. The Xtensa ISA (used in e.g. ESP8266 or ESP32-S2 and ESP32-S3) is not supported.
73+
74+
For ESP microcontrollers using the ESP-IDF framework, an article will be added to this documentation in the future.
7075

7176
### STM32
7277

Sources/EmbeddedSwift/Documentation.docc/UsingEmbeddedSwift/Basics.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,4 @@ It's very common to integrate with existing SDKs in embedded development. This t
7373
2. **Creating a bridging header** that exposes the C functions and types from the SDK to Swift.
7474
3. **Configuring the build system** to compile Swift code with the right flags and link it with the SDK's libraries.
7575

76-
Most embedded SDKs provide a build system integration, commonly with CMake, Make, or their own custom build scripts. At the most basic level, it's always possible to manually call the compiler (`swiftc`) as described above from any build system. This will produce a .o file for the entire Swift module, and then a .o file can typically be directly used in the build system.
77-
78-
For details and concrete examples of how to integrate with more common platforms, SDKs and build systems, see <doc:IntegratingWithPlatforms>.
76+
Most embedded SDKs provide a build system integration, commonly with CMake, Make, or their own custom build scripts. For details and concrete examples of how to integrate with more common platforms, SDKs and build systems, see <doc:IntegratingWithPlatforms>.

0 commit comments

Comments
 (0)