espressif/esptool
1
0
Fork 0
mirror of https://github.com/espressif/esptool.git synced 2025-10-20 13:23:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update migration guide for espefuse with click parser

Browse Source
This commit is contained in:
Peter Dragun
2025-04-24 14:02:19 +02:00
parent fac9b30c84
commit faf3e221a6
2 changed files with 32 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/en/installation.rst
View File

@@ -103,7 +103,9 @@ You will likely have to restart or re-login for the autocompletion to start work
.. code-block:: bash .. 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 .. 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 .. 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 .. group-tab:: Fish
.. code-block:: bash .. 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

23
docs/en/migration-guide.rst
View File

@@ -284,3 +284,26 @@ Choices for the ``--before`` option have been renamed to use ``-`` instead of ``
**Migration Steps:** **Migration Steps:**
1. Replace all underscores in the ``--before`` option with ``-`` in your scripts. 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.