Skip to content

Commit cd681a2

Browse files
committed
add note about splitting arduino files
1 parent 183cc9d commit cd681a2

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

docs/developer/optimizations.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ that are needed all over the module. This block is saved as a `.h` file and
5151
`#include`'d by all the following blocks.
5252

5353
In most cases this is already sufficient. Only in very rare cases the
54-
position of a split needs the be edited. This is automatically done by the
55-
patches in the `patches/` directory.
54+
position of a split needs the be edited.
5655

5756
**To prevent a split**: Change the `/**` line into something different, `/***`
5857
is used in the scripts.
5958

6059
**To force a split**: Add an empty Doxygen comment block:
6160
```c
6261
/**
62+
* This is just a split marker
6363
*/
6464
```
6565

@@ -73,6 +73,10 @@ Splitting and compiling the SPL libraries is moved into the separate project
7373

7474
### Split Arduino core files
7575

76+
The Arduino files don't have any regular structure. They need to be edited
77+
to become splitable at all and some of the resulting split files still need
78+
manual adjustments.
79+
7680
`wiring.c`, `wiring_digital.c` and `HardwareSerial.c` all compile into quite
7781
large binaries. All of them are linked with almost
7882
every project. This is true even if no serial communication is used since

0 commit comments

Comments
 (0)