From 91afa70a370990ca11b3fe1d5de01286c2b0d0d0 Mon Sep 17 00:00:00 2001 From: Moshe Shahar Date: Wed, 30 Jun 2021 13:51:17 +0300 Subject: [PATCH] Clarify use of `--fw-version` option --- README.md | 4 +++- manifesttool/dev_tool/actions/create.py | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50b3091..1dd67d1 100644 --- a/README.md +++ b/README.md @@ -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: @@ -210,7 +211,7 @@ describing the update type. --output my.manifest.bin ``` -**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. +**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. #### `manifest-tool create-v1` @@ -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 ``` diff --git a/manifesttool/dev_tool/actions/create.py b/manifesttool/dev_tool/actions/create.py index 4a75066..3180cfa 100644 --- a/manifesttool/dev_tool/actions/create.py +++ b/manifesttool/dev_tool/actions/create.py @@ -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( @@ -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(