Skip to content

Commit 6c4f7b4

Browse files
butoknordicjm
authored andcommitted
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 <[email protected]>
1 parent e9fccef commit 6c4f7b4

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

docs/imgtool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ primary slot and adds a header and trailer that the bootloader is expecting:
6161
Options:
6262
-k, --key filename
6363
--public-key-format [hash|full]
64-
--align [1|2|4|8] [required]
64+
--align [1|2|4|8|16|32] Alignment used by swap update modes.
6565
-v, --version TEXT [required]
6666
-s, --security-counter TEXT Specify the value of security counter. Use
6767
the `auto` keyword to automatically generate

scripts/imgtool/main.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,8 @@ def convert(self, value, param, ctx):
377377
'keyword to automatically generate it from the image version.')
378378
@click.option('-v', '--version', callback=validate_version, required=True)
379379
@click.option('--align', type=click.Choice(['1', '2', '4', '8', '16', '32']),
380-
required=False)
380+
required=False,
381+
help='Alignment used by swap update modes.')
381382
@click.option('--max-align', type=click.Choice(['8', '16', '32']),
382383
required=False,
383384
help='Maximum flash alignment. Set if flash alignment of the '

0 commit comments

Comments
 (0)