Skip to content

Commit

Permalink
Clarify use of --fw-version option
Browse files Browse the repository at this point in the history
  • Loading branch information
Moshe Shahar committed Jul 12, 2021
1 parent 56f0c41 commit 91afa70
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ describing the update type.
url: http://some-url.com/files?id=1234
file-path: ./my.fw.bin
format: raw-binary
component: MAIN
```

* Run:
Expand All @@ -210,7 +211,7 @@ describing the update type.
--output my.manifest.bin
```

<span class="notes">**Note:** The value of `--fw-version` can be between 0.0.1 and 999.999.999 and must be bigger than the firmware version currently installed on the device.</span>
<span class="notes">**Note:** The value of `--fw-version` refers to the firmware version of the component to be updated. The value can be between 0.0.1 and 999.999.999 and must be greater than the firmware version currently installed on the device.</span>

#### `manifest-tool create-v1`

Expand Down Expand Up @@ -415,6 +416,7 @@ manifest-dev-tool create \
--payload-url http://test.pdmc.pelion.com?fileId=1256 \
--payload-path new_fw.bin \
--fw-version 1.2.3 \
--component-name MAIN \
--output update-manifest.bin
```

Expand Down
4 changes: 2 additions & 2 deletions manifesttool/dev_tool/actions/create.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def register_parser(parser: argparse.ArgumentParser,
optional.add_argument(
'-e', '--encrypt-payload',
action='store_true',
help='Encrypt the payload device downloads.',
help='Encrypt the payload the device downloads.',
)
else:
optional.add_argument(
Expand Down Expand Up @@ -122,7 +122,7 @@ def register_parser(parser: argparse.ArgumentParser,
metavar='NAME',
help='The name of the component to be udpated. '
'Must correspond to an existing component '
'name on target devices.'
'name on target devices. [Default: MAIN].'
)
if is_update_parser:
optional.add_argument(
Expand Down

0 comments on commit 91afa70

Please sign in to comment.