kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-27 07:21:18 +01:00
Code Releases Activity

doc/porting-boards: document board alias feature

Browse Source
This commit is contained in:
Mikolai Gütschow 2025-04-01 10:46:06 +02:00
parent f565eacfce
commit 96694ab31a
No known key found for this signature in database
GPG Key ID: 943E2F37AA659AD5
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/doxygen/src/porting-boards.md
View File

@ -392,7 +392,21 @@ In this case some special considerations must be taken with the makefiles:
`include $(RIOTBOARD)/foo-parent/Makefile.*include*`
An example can be found in
[`tests/build_system/external_board_native`](https://github.com/RIOT-OS/RIOT/tree/master/tests/build_system/external_board_native)
[`tests/build_system/external_board_native`](https://github.com/RIOT-OS/RIOT/tree/master/tests/build_system/external_board_native).
# Board names and aliases {#boards-alias}
New boards should be named according to
[RDM0003](https://github.com/RIOT-OS/RIOT/blob/master/doc/memos/rdm0003.md).
Historically, some board names have not followed this structure.
For backwards compatibility, RIOT supports board aliases that can be used
in place of the actual board name in the environment or Make variable `BOARD`.
A list of all existing board aliases can be found in
[`makefiles/board_alias.inc.mk](https://github.com/RIOT-OS/RIOT/blob/master/makefiles/board_alias.inc.mk).
[`BOARD=native`](@ref boards_common_native) is a special alias in that it
resolves to either [`native32`](@ref boards_native32) or [`native64`](@ref boards_native64)
depending on the host architecture.
# Tools {#boards-tools}