mirror of
https://github.com/espressif/esptool.git
synced 2025-10-19 02:43:00 +08:00
docs: Update migration guide for espefuse with click parser
This commit is contained in:
@@ -103,7 +103,9 @@ You will likely have to restart or re-login for the autocompletion to start work
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
eval "$(_ESPTOOL_PY_COMPLETE=bash_source esptool.py espsecure.py espefuse.py)"
|
||||
eval "$(_ESPTOOL_PY_COMPLETE=bash_source esptool.py)"
|
||||
eval "$(_ESPSECURE_PY_COMPLETE=bash_source espsecure.py)"
|
||||
eval "$(_ESPEFUSE_PY_COMPLETE=bash_source espefuse.py)"
|
||||
|
||||
|
||||
.. group-tab:: Zsh
|
||||
@@ -121,14 +123,18 @@ You will likely have to restart or re-login for the autocompletion to start work
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
eval "$(_ESPTOOL_PY_COMPLETE=zsh_source esptool.py espsecure.py espefuse.py)"
|
||||
eval "$(_ESPTOOL_PY_COMPLETE=zsh_source esptool.py)"
|
||||
eval "$(_ESPSECURE_PY_COMPLETE=zsh_source espsecure.py)"
|
||||
eval "$(_ESPEFUSE_PY_COMPLETE=zsh_source espefuse.py)"
|
||||
|
||||
|
||||
.. group-tab:: Fish
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
_ESPTOOL_PY_COMPLETE=fish_source esptool.py espsecure.py espefuse.py | source
|
||||
_ESPTOOL_PY_COMPLETE=fish_source esptool.py | source
|
||||
_ESPSECURE_PY_COMPLETE=fish_source espsecure.py | source
|
||||
_ESPEFUSE_PY_COMPLETE=fish_source espefuse.py | source
|
||||
|
||||
|
||||
|
||||
|
@@ -284,3 +284,26 @@ Choices for the ``--before`` option have been renamed to use ``-`` instead of ``
|
||||
**Migration Steps:**
|
||||
|
||||
1. Replace all underscores in the ``--before`` option with ``-`` in your scripts.
|
||||
|
||||
Command and Option Renaming
|
||||
###########################
|
||||
|
||||
All the commands and options have been renamed to use ``-`` instead of ``_`` as a separator (e.g., ``burn_custom_mac`` -> ``burn-custom-mac``).
|
||||
|
||||
From options only ``--file_name`` has been renamed to ``--file-name``.
|
||||
|
||||
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.
|
||||
|
||||
**Migration Steps:**
|
||||
|
||||
1. Replace all underscores in the command names with ``-`` in your scripts.
|
||||
|
||||
|
||||
``--port`` Option is Required
|
||||
#############################
|
||||
|
||||
The ``--port`` option is now required for all commands (except when using ``--virt``). Previously it was optional and defaulted to ``/dev/ttyUSB0``.
|
||||
|
||||
**Migration Steps:**
|
||||
|
||||
1. Add the ``--port`` option to all your espefuse commands.
|
||||
|
Reference in New Issue
Block a user