OrgZephyr/mcuboot
OrgZephyr
/
mcuboot
mirror of https://github.com/zephyrproject-rtos/mcuboot.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: imgtool: update align description 

Update the --align option values.
Add its description.
Delete [required], as it is optional now.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
This commit is contained in:
Andrej Butok 2023-11-06 15:01:19 +01:00 committed by Jamie
parent e9fccef5dd
commit 6c4f7b4c63
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/imgtool.md
View File

@ -61,7 +61,7 @@ primary slot and adds a header and trailer that the bootloader is expecting:
Options: Options:
-k, --key filename -k, --key filename
--public-key-format [hash|full] --public-key-format [hash|full]
--align [1|2|4|8] [required] --align [1|2|4|8|16|32] Alignment used by swap update modes.
-v, --version TEXT [required] -v, --version TEXT [required]
-s, --security-counter TEXT Specify the value of security counter. Use -s, --security-counter TEXT Specify the value of security counter. Use
the `auto` keyword to automatically generate the `auto` keyword to automatically generate

3
scripts/imgtool/main.py
View File

@ -377,7 +377,8 @@ class BasedIntParamType(click.ParamType):
'keyword to automatically generate it from the image version.') 'keyword to automatically generate it from the image version.')
@click.option('-v', '--version', callback=validate_version, required=True) @click.option('-v', '--version', callback=validate_version, required=True)
@click.option('--align', type=click.Choice(['1', '2', '4', '8', '16', '32']), @click.option('--align', type=click.Choice(['1', '2', '4', '8', '16', '32']),
required=False) required=False,
help='Alignment used by swap update modes.')
@click.option('--max-align', type=click.Choice(['8', '16', '32']), @click.option('--max-align', type=click.Choice(['8', '16', '32']),
required=False, required=False,
help='Maximum flash alignment. Set if flash alignment of the ' help='Maximum flash alignment. Set if flash alignment of the '