Skip to content

Commit faf3e22

Browse files
committed
docs: Update migration guide for espefuse with click parser
1 parent fac9b30 commit faf3e22

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

docs/en/installation.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ You will likely have to restart or re-login for the autocompletion to start work
103103

104104
.. code-block:: bash
105105
106-
eval "$(_ESPTOOL_PY_COMPLETE=bash_source esptool.py espsecure.py espefuse.py)"
106+
eval "$(_ESPTOOL_PY_COMPLETE=bash_source esptool.py)"
107+
eval "$(_ESPSECURE_PY_COMPLETE=bash_source espsecure.py)"
108+
eval "$(_ESPEFUSE_PY_COMPLETE=bash_source espefuse.py)"
107109
108110
109111
.. group-tab:: Zsh
@@ -121,14 +123,18 @@ You will likely have to restart or re-login for the autocompletion to start work
121123

122124
.. code-block:: bash
123125
124-
eval "$(_ESPTOOL_PY_COMPLETE=zsh_source esptool.py espsecure.py espefuse.py)"
126+
eval "$(_ESPTOOL_PY_COMPLETE=zsh_source esptool.py)"
127+
eval "$(_ESPSECURE_PY_COMPLETE=zsh_source espsecure.py)"
128+
eval "$(_ESPEFUSE_PY_COMPLETE=zsh_source espefuse.py)"
125129
126130
127131
.. group-tab:: Fish
128132

129133
.. code-block:: bash
130134
131-
_ESPTOOL_PY_COMPLETE=fish_source esptool.py espsecure.py espefuse.py | source
135+
_ESPTOOL_PY_COMPLETE=fish_source esptool.py | source
136+
_ESPSECURE_PY_COMPLETE=fish_source espsecure.py | source
137+
_ESPEFUSE_PY_COMPLETE=fish_source espefuse.py | source
132138
133139
134140

docs/en/migration-guide.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,3 +284,26 @@ Choices for the ``--before`` option have been renamed to use ``-`` instead of ``
284284
**Migration Steps:**
285285

286286
1. Replace all underscores in the ``--before`` option with ``-`` in your scripts.
287+
288+
Command and Option Renaming
289+
###########################
290+
291+
All the commands and options have been renamed to use ``-`` instead of ``_`` as a separator (e.g., ``burn_custom_mac`` -> ``burn-custom-mac``).
292+
293+
From options only ``--file_name`` has been renamed to ``--file-name``.
294+
295+
Old command and option names are **deprecated**, meaning they will work for now with a warning, but will be removed in the next major release.
296+
297+
**Migration Steps:**
298+
299+
1. Replace all underscores in the command names with ``-`` in your scripts.
300+
301+
302+
``--port`` Option is Required
303+
#############################
304+
305+
The ``--port`` option is now required for all commands (except when using ``--virt``). Previously it was optional and defaulted to ``/dev/ttyUSB0``.
306+
307+
**Migration Steps:**
308+
309+
1. Add the ``--port`` option to all your espefuse commands.

0 commit comments

Comments
 (0)