Skip to content

Commit 7444e5c

Browse files
committed
Update README.md for the --rename option.
1 parent b42676f commit 7444e5c

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Micropython app fills 82.3% of factory partition (350 kB free)
7070
- `--table nvs=6B,phy_init=1B,factory=0x1f0B,vfs=0` : specify a table layout
7171
- `--resize factory=2M,vfs=0x400K` : resize any partition (adjust other
7272
parts to fit)
73+
- `--rename factory=app,ffat=vfs` : rename one or more partitions
7374
- `--delete phy_init --resize nvs=0` : delete 'phy_init' and expand 'nvs' to
7475
use free space
7576
- `--add vfs2=fat:2M:1M` : add a new FS data partition at offset 0x200000 with
@@ -427,6 +428,7 @@ usage: mp-image-tool-esp32 [-h] [-o FILE] [-q] [-n] [-x] [-f SIZE] [-a SIZE]
427428
[--delete NAME1[,NAME2]]
428429
[--add NAME1:SUBTYPE:OFFSET:SIZE[,NAME2,...]]
429430
[--resize NAME1=SIZE1[,NAME2=SIZE2]]
431+
[--rename NAME1=NEW1[,NAME2=NEW2]]
430432
[--erase NAME1[,NAME2]] [--erase-fs NAME1[,NAME2]]
431433
[--read NAME1=FILE1[,NAME2=FILE2,bootloader=FILE,...]]
432434
[--write NAME1=FILE1[,NAME2=FILE2,bootloader=FILE,...]]
@@ -476,6 +478,8 @@ options:
476478
resize partitions eg. --resize
477479
factory=2M,nvs=5B,vfs=0. If SIZE is 0, expand
478480
partition to available space
481+
--rename NAME1=NEW1[,NAME2=NEW2,...]
482+
rename partitions, eg. --rename ffat=vfs,factory=app
479483
--erase NAME1[,NAME2]
480484
erase the named partitions
481485
--erase-fs NAME1[,NAME2]
@@ -500,10 +504,12 @@ options:
500504
501505
Where SIZE is a decimal or hex number with an optional suffix (M=megabytes,
502506
K=kilobytes, B=blocks (0x1000=4096 bytes)). --fs commands include: ls, get,
503-
put, mkdir, rm, rename, cat, info, mkfs, df and grow. Options --erase-fs and
504-
--ota-update can only be used when operating on serial-attached devices (not
505-
firmware files). If the --flash option is provided, the firmware (including
506-
any changes made) will be flashed to the device, eg: `mp-image-tool-esp32
507-
firmware.bin --flash u0` is a convenient way to flash firmware to a device.
507+
put, mkdir, rm, rename, cat, info, mkfs, df and grow. --fs will swallow any
508+
non-option arguments following, so use `--` to separate them if needed, eg
509+
`--fs ls /lib /bin -- firmware.bin`. Options --erase-fs and --ota-update can
510+
only be used when operating on serial-attached devices (not firmware files).
511+
If the --flash option is provided, the firmware (including any changes made)
512+
will be flashed to the device, eg: `mp-image-tool-esp32 firmware.bin --flash u0`
513+
is a convenient way to flash firmware to a device.
508514
509515
```

0 commit comments

Comments
 (0)