diff --git a/components/app_update/otatool.py b/components/app_update/otatool.py index 5033053562..5ca0c015b7 100755 --- a/components/app_update/otatool.py +++ b/components/app_update/otatool.py @@ -290,7 +290,7 @@ def main(): subparsers.add_parser('switch_ota_partition', help='switch otadata partition', parents=[slot_or_name_parser, spi_flash_sec_size]) read_ota_partition_subparser = subparsers.add_parser('read_ota_partition', help='read contents of an ota partition', parents=[slot_or_name_parser]) - read_ota_partition_subparser.add_argument('--output', help='file to write the contents of the ota partition to') + read_ota_partition_subparser.add_argument('--output', help='file to write the contents of the ota partition to', required=True) write_ota_partition_subparser = subparsers.add_parser('write_ota_partition', help='write contents to an ota partition', parents=[slot_or_name_parser]) write_ota_partition_subparser.add_argument('--input', help='file whose contents to write to the ota partition') diff --git a/docs/en/api-reference/system/ota.rst b/docs/en/api-reference/system/ota.rst index e2dd0b09ee..3f8bd7ef9a 100644 --- a/docs/en/api-reference/system/ota.rst +++ b/docs/en/api-reference/system/ota.rst @@ -288,7 +288,7 @@ The command-line interface of `otatool.py` has the following structure: otatool.py --port "/dev/ttyUSB1" switch_ota_partition --slot 1 # Read OTA partition 'ota_3' and save contents to a file named 'ota_3.bin' - otatool.py --port "/dev/ttyUSB1" read_ota_partition --name=ota_3 + otatool.py --port "/dev/ttyUSB1" read_ota_partition --name=ota_3 --output=ota_3.bin More information can be obtained by specifying `--help` as argument: diff --git a/docs/zh_CN/api-reference/system/ota.rst b/docs/zh_CN/api-reference/system/ota.rst index b3ac7f396b..ecd43c5c56 100644 --- a/docs/zh_CN/api-reference/system/ota.rst +++ b/docs/zh_CN/api-reference/system/ota.rst @@ -269,7 +269,7 @@ Python API otatool.py --port "/dev/ttyUSB1" switch_ota_partition --slot 1 # 读取 OTA 分区 'ota_3',将内容保存至文件 'ota_3.bin' - otatool.py --port "/dev/ttyUSB1" read_ota_partition --name=ota_3 + otatool.py --port "/dev/ttyUSB1" read_ota_partition --name=ota_3 --output=ota_3.bin 更多信息可用 `--help` 指令查看: