1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

Merge pull request #16025 from chrysn-pull-requests/bootloader-docs

doc: Make bootloaders visible in modules
This commit is contained in:
Martine Lenders 2021-02-18 19:45:06 +01:00 committed by GitHub
commit 6b8cb2a732
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 3 deletions

5
bootloaders/doc.txt Normal file
View File

@ -0,0 +1,5 @@
/**
* @defgroup bootloaders Bootloaders
* @brief Applications that facilitate the startup process in presence of upgradable firmware
*
*/

View File

@ -1,3 +1,7 @@
/**
@defgroup bootloader_riotboot riotboot
@ingroup bootloaders
# Overview
This folder contains a simple bootloader called "riotboot".
A header with metadata of length `RIOTBOOT_HDR_LEN` precedes
@ -48,7 +52,7 @@ no image will be booted and the bootloader will enter `while(1);` endless loop.
# Requirements
Try to compile and run tests/riotboot:
$ BOARD=<board> make -C tests/riotboot flash test
$ BOARD=<board> make -C tests/riotboot flash test
If the test succeeds, your board is supported. Else you can try to port
riotboot to your board (see the below porting guide).
@ -103,7 +107,7 @@ flash` if the `riotboot` feature is used.
## Testing riotboot
See [tests/riotboot/README.md](https://github.com/RIOT-OS/RIOT/blob/master/tests/riotboot/README.md).
See <a href="https://github.com/RIOT-OS/RIOT/blob/master/tests/riotboot/README.md">tests/riotboot/README.md</a>.
# Quick riotboot porting guide
@ -151,3 +155,5 @@ offset and a defined firmware size. To get an idea look at
Additional remarks:
- If your are in Big-Endian, you may need to further adapt some part of the code.
*/

View File

@ -8,7 +8,6 @@
*/
/**
* @defgroup bootloaders RIOT compatible bootloaders
* @ingroup bootloaders
* @{
*

View File

@ -757,6 +757,7 @@ INPUT = ../../doc.txt \
../../core \
../../cpu \
../../boards \
../../bootloaders \
../../drivers \
../../pkg \
../../sys \