Skip to content

Commit 14e5d93

Browse files
committed
change(espefuse_dump): Rename united and separated formats to joint and split
1 parent 8ee6ea1 commit 14e5d93

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/en/espefuse/dump-cmd.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Optional arguments:
1212

1313
- ``--format`` - Selects the dump format:
1414
- ``default`` - Usual console eFuse dump;
15-
- ``united`` - All eFuse blocks are stored in one file;
16-
- ``separated`` - Each eFuse block is placed in a separate file. The tool will create multiple files based on the given the ``--file_name`` argument. Example: "--file_name /path/blk.bin", blk0.bin, blk1.bin ... blkN.bin. Use the ``burn_block_data`` cmd to write it back to another chip.
15+
- ``joint`` - All eFuse blocks are stored in one file;
16+
- ``split`` - Each eFuse block is placed in its own file. The tool will create multiple files based on the given the ``--file_name`` argument. Example: "--file_name /path/blk.bin", blk0.bin, blk1.bin ... blkN.bin. Use the ``burn_block_data`` cmd to write it back to another chip.
1717
- ``--file_name`` - The path to the file in which to save the dump, if not specified, output to the console.
1818

1919
Raw Values Of Efuse Registers
@@ -93,7 +93,7 @@ This command saves dump for each block into a separate file. You need to provide
9393

9494
.. code-block:: none
9595
96-
> espefuse.py dump --format separated --file_name backup/chip1/blk.bin
96+
> espefuse.py dump --format split --file_name backup/chip1/blk.bin
9797
9898
=== Run "dump" command ===
9999
backup/chip1/blk0.bin
@@ -120,7 +120,7 @@ To save all eFuse blocks in one file, use the following command:
120120

121121
.. code-block:: none
122122
123-
> espefuse.py dump --format united --file_name backup/chip1/efuses.bin
123+
> espefuse.py dump --format joint --file_name backup/chip1/efuses.bin
124124
125125
=== Run "dump" command ===
126126
backup/chip1/efuses.bin

espefuse/efuse/base_operations.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,11 @@ def check_efuse_name(efuse_name, efuse_list):
179179
"--format",
180180
help="Select the dump format: "
181181
"default - usual console eFuse dump; "
182-
"united - all eFuse blocks are stored in one file; "
183-
"separated - each eFuse block is placed in a separate file. Tool will create multiple files based on "
182+
"joint - all eFuse blocks are stored in one file; "
183+
"split - each eFuse block is placed into its own file. The tool will create multiple files based on "
184184
"the given --file_name (/path/blk.bin): blk0.bin, blk1.bin ... blkN.bin. Use the burn_block_data cmd "
185185
"to write it back to another chip.",
186-
choices=["default", "separated", "united"],
186+
choices=["default", "split", "joint"],
187187
default="default",
188188
)
189189
dump_cmd.add_argument(
@@ -409,10 +409,10 @@ def output_block_to_file(block, f, to_console):
409409
return
410410
else:
411411
# for back compatibility to support "espefuse.py dump --file_name dump.bin"
412-
args.format = "separated"
412+
args.format = "split"
413413

414-
if args.format == "separated":
415-
# each efuse block is placed in a separate file
414+
if args.format == "split":
415+
# each efuse block is placed into its own file
416416
for block in efuses.blocks:
417417
if not to_console:
418418
file_dump_name = args.file_name
@@ -423,7 +423,7 @@ def output_block_to_file(block, f, to_console):
423423
output_block_to_file(block, dump_file, to_console)
424424
if not to_console:
425425
dump_file.close()
426-
elif args.format == "united":
426+
elif args.format == "joint":
427427
# all efuse blocks are stored in one file
428428
if not to_console:
429429
print(f"Dump efuse blocks -> {args.file_name}")

test/test_espefuse.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -183,17 +183,17 @@ def test_dump(self):
183183
self.espefuse_py("dump -h")
184184
self.espefuse_py("dump")
185185

186-
def test_dump_format_united(self):
186+
def test_dump_format_joint(self):
187187
tmp_file = tempfile.NamedTemporaryFile(delete=False)
188-
self.espefuse_py(f"dump --format united --file_name {tmp_file.name}")
188+
self.espefuse_py(f"dump --format joint --file_name {tmp_file.name}")
189189

190-
def test_dump_separated_default(self):
190+
def test_dump_split_default(self):
191191
tmp_file = tempfile.NamedTemporaryFile(delete=False)
192192
self.espefuse_py(f"dump --file_name {tmp_file.name}")
193193

194-
def test_dump_separated(self):
194+
def test_dump_split(self):
195195
tmp_file = tempfile.NamedTemporaryFile(delete=False)
196-
self.espefuse_py(f"dump --format separated --file_name {tmp_file.name}")
196+
self.espefuse_py(f"dump --format split --file_name {tmp_file.name}")
197197

198198
def test_summary(self):
199199
self.espefuse_py("summary -h")

0 commit comments

Comments
 (0)