mirror of
https://github.com/apache/nuttx-apps.git
synced 2025-10-14 10:48:10 +08:00
boot/nxboot: improve documentation
Previously it was hard to guess the correct entrypoint for the bootloader application. Signed-off-by: Lars Kruse <devel@sumpfralle.de>
This commit is contained in:
@@ -40,6 +40,9 @@ config NXBOOT_HEADER_SIZE
|
|||||||
hex "Application firmware image header size"
|
hex "Application firmware image header size"
|
||||||
default 0x200
|
default 0x200
|
||||||
---help---
|
---help---
|
||||||
|
The nxboot bootloader itself requires only a few bytes of header
|
||||||
|
data. Increase this value, if you need to store additional
|
||||||
|
application-specific meta data.
|
||||||
Note that this size should be aligned with the program memory write
|
Note that this size should be aligned with the program memory write
|
||||||
page size!
|
page size!
|
||||||
|
|
||||||
@@ -59,8 +62,9 @@ config NXBOOT_BOOTLOADER
|
|||||||
select BOARDCTL_BOOT_IMAGE
|
select BOARDCTL_BOOT_IMAGE
|
||||||
---help---
|
---help---
|
||||||
This option builds and links a bootloader application. This application
|
This option builds and links a bootloader application. This application
|
||||||
should be an entry function for NuttX. It checks for possible update/
|
("nxboot_loader_main") should be the entry function for NuttX.
|
||||||
revert operation, performs it and boot the correct image.
|
It checks for a possible update/revert operation, performs it and boots
|
||||||
|
the correct image.
|
||||||
|
|
||||||
if NXBOOT_BOOTLOADER
|
if NXBOOT_BOOTLOADER
|
||||||
|
|
||||||
|
@@ -116,7 +116,7 @@ def parse_args() -> argparse.Namespace:
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-v",
|
"-v",
|
||||||
action="store_true",
|
action="store_true",
|
||||||
help="Verbose output. This prints information abourt the created image.",
|
help="Verbose output. This prints information about the created image.",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"PATH",
|
"PATH",
|
||||||
|
Reference in New Issue
Block a user