Skip to content

Commit 00911d4

Browse files
sumpfrallexiaoxiang781216
authored andcommitted
boot/nxboot: improve documentation
Previously it was hard to guess the correct entrypoint for the bootloader application. Signed-off-by: Lars Kruse <[email protected]>
1 parent a85121b commit 00911d4

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

boot/nxboot/Kconfig

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ config NXBOOT_HEADER_SIZE
4040
hex "Application firmware image header size"
4141
default 0x200
4242
---help---
43+
The nxboot bootloader itself requires only a few bytes of header
44+
data. Increase this value, if you need to store additional
45+
application-specific meta data.
4346
Note that this size should be aligned with the program memory write
4447
page size!
4548

@@ -59,8 +62,9 @@ config NXBOOT_BOOTLOADER
5962
select BOARDCTL_BOOT_IMAGE
6063
---help---
6164
This option builds and links a bootloader application. This application
62-
should be an entry function for NuttX. It checks for possible update/
63-
revert operation, performs it and boot the correct image.
65+
("nxboot_loader_main") should be the entry function for NuttX.
66+
It checks for a possible update/revert operation, performs it and boots
67+
the correct image.
6468

6569
if NXBOOT_BOOTLOADER
6670

boot/nxboot/tools/nximage.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ def parse_args() -> argparse.Namespace:
116116
parser.add_argument(
117117
"-v",
118118
action="store_true",
119-
help="Verbose output. This prints information abourt the created image.",
119+
help="Verbose output. This prints information about the created image.",
120120
)
121121
parser.add_argument(
122122
"PATH",

0 commit comments

Comments
 (0)