mirror of
https://github.com/espressif/esp-idf.git
synced 2025-10-03 02:20:57 +02:00
Merge branch 'docs/add-config-migration' into 'master'
docs: add link to esp-idf-kconfig migration guide See merge request espressif/esp-idf!40898
This commit is contained in:
@@ -74,3 +74,8 @@ To explicitly control constructor order, use the ``constructor()`` function attr
|
|||||||
void foo(void);
|
void foo(void);
|
||||||
|
|
||||||
Replace ``PRIO`` with an integer value. Lower values are executed earlier. This is the preferred method when specific ordering is required.
|
Replace ``PRIO`` with an integer value. Lower values are executed earlier. This is the preferred method when specific ordering is required.
|
||||||
|
|
||||||
|
Changes in Configuration Files Syntax
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
ESP-IDF v6 uses esp-idf-kconfig v3, which introduces several changes in the configuration (``Kconfig``) files. For the full list of changes, please refer to the `esp-idf-kconfig migration guide from v2.x to v3.x <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/developer-guide/migration-guide.html>`_.
|
||||||
|
@@ -3,24 +3,24 @@ Tools
|
|||||||
|
|
||||||
:link_to_translation:`zh_CN:[中文]`
|
:link_to_translation:`zh_CN:[中文]`
|
||||||
|
|
||||||
GDBGUI installation
|
gdbgui Installation
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
The support for the ``--enable-gdbgui`` argument has been removed from the install scripts and `gdbgui <https://www.gdbgui.com>`_ cannot be installed this way anymore. Please use the ``pipx`` method from the `gdbgui installation guide <https://www.gdbgui.com/installation/>`_ in order to set up this tool.
|
The support for the ``--enable-gdbgui`` argument has been removed from the install scripts, and `gdbgui <https://www.gdbgui.com>`_ cannot be installed this way anymore. Please use the ``pipx`` method from the `gdbgui installation guide <https://www.gdbgui.com/installation/>`_ in order to set up this tool.
|
||||||
|
|
||||||
Depending on your operating system and Python version, you may need to consult the `list of known issues <https://github.com/cs01/gdbgui/issues>`_.
|
Depending on your operating system and Python version, you may need to consult the `list of known issues <https://github.com/cs01/gdbgui/issues>`_.
|
||||||
|
|
||||||
For example, `Python 3.13 is not supported <https://github.com/cs01/gdbgui/issues/494>`_ on any operating systems at the moment.
|
For example, `Python 3.13 is not supported <https://github.com/cs01/gdbgui/issues/494>`_ on any operating systems at the moment.
|
||||||
|
|
||||||
The Windows operating system is not supported since gdbgui version 0.14. Because of the existence of other issues, you will need Python 3.10 with some specific versions of the dependencies. The last know working gdbgui and dependency versions can be installed with the following command:
|
The Windows operating system is not supported since gdbgui version 0.14. Because of the existence of other issues, you will need Python 3.10 with some specific versions of the dependencies. The last known working gdbgui and dependency versions can be installed with the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pipx install "gdbgui==0.13.2.0" "pygdbmi<=0.9.0.2" "python-socketio<5" "jinja2<3.1" "itsdangerous<2.1"
|
pipx install "gdbgui==0.13.2.0" "pygdbmi<=0.9.0.2" "python-socketio<5" "jinja2<3.1" "itsdangerous<2.1"
|
||||||
```
|
```
|
||||||
|
|
||||||
On Linux or MacOS, you can use Python 3.11 or 3.12 and gdbgui version 0.15.2.0.
|
On Linux or macOS, you can use Python 3.11 or 3.12 and gdbgui version 0.15.2.0.
|
||||||
|
|
||||||
Please be aware that these recommendations may change over time and for an up-to-date list of issues refer to `the official issue tracker <https://github.com/cs01/gdbgui/issues>`_.
|
Please be aware that these recommendations may change over time. For an up-to-date list of issues, please refer to `the official issue tracker <https://github.com/cs01/gdbgui/issues>`_.
|
||||||
|
|
||||||
We recommend to use ``idf.py gdb`` instead of ``idf.py gdbgui``, or debug in Eclipse/Vscode if you encounter an issue with the installation.
|
We recommend to use ``idf.py gdb`` instead of ``idf.py gdbgui``, or debug in Eclipse/Vscode if you encounter an issue with the installation.
|
||||||
|
|
||||||
@@ -31,7 +31,6 @@ All commands with eFuse functionality now require a serial port to be specified.
|
|||||||
|
|
||||||
For all ``idf.py efuse*`` commands, you now need to specify the serial port with the ``--port`` argument (or ``ESPPORT`` environment variable). If the port is not specified, the command will fail with an error message.
|
For all ``idf.py efuse*`` commands, you now need to specify the serial port with the ``--port`` argument (or ``ESPPORT`` environment variable). If the port is not specified, the command will fail with an error message.
|
||||||
|
|
||||||
|
|
||||||
Python 3.9 Deprecation
|
Python 3.9 Deprecation
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
@@ -40,3 +39,8 @@ Python 3.9 is no longer supported. The minimum required Python version is now 3.
|
|||||||
Refer to the official `Python documentation <https://docs.python.org/3/using/index.html>`_ for instructions on upgrading Python for your operating system.
|
Refer to the official `Python documentation <https://docs.python.org/3/using/index.html>`_ for instructions on upgrading Python for your operating system.
|
||||||
|
|
||||||
For Linux users, it is recommended to upgrade to a newer version of your distribution that includes a supported Python version.
|
For Linux users, it is recommended to upgrade to a newer version of your distribution that includes a supported Python version.
|
||||||
|
|
||||||
|
Changes in Configuration Files Syntax
|
||||||
|
-------------------------------------
|
||||||
|
|
||||||
|
ESP-IDF v6 uses esp-idf-kconfig v3, which introduces several changes in the configuration (``Kconfig``) files. For the full list of changes, please refer to the `esp-idf-kconfig migration guide from v2.x to v3.x <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/developer-guide/migration-guide.html>`_.
|
||||||
|
@@ -74,3 +74,9 @@
|
|||||||
void foo(void);
|
void foo(void);
|
||||||
|
|
||||||
将 ``PRIO`` 替换为整数值。值越小,执行越早。当对执行顺序有特定要求时,这种方式是首选。
|
将 ``PRIO`` 替换为整数值。值越小,执行越早。当对执行顺序有特定要求时,这种方式是首选。
|
||||||
|
方案3 **不推荐使用**,因为孤立段可能意味着内存映射配置存在问题,或应用程序中存在非预期行为。
|
||||||
|
|
||||||
|
配置文件语法变更
|
||||||
|
------------------
|
||||||
|
|
||||||
|
ESP-IDF v6 使用了 esp-idf-kconfig v3,对配置文件 ``Kconfig`` 的语法进行了若干变更。完整变更列表请参阅 `Migration Guide From esp-idf-kconfig v2.x to v3.x <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/developer-guide/migration-guide.html>`_。
|
||||||
|
@@ -1 +1,37 @@
|
|||||||
.. include:: ../../../../en/migration-guides/release-6.x/6.0/tools.rst
|
工具
|
||||||
|
====
|
||||||
|
|
||||||
|
:link_to_translation:`en:[English]`
|
||||||
|
|
||||||
|
安装 gdbgui
|
||||||
|
-----------
|
||||||
|
|
||||||
|
安装脚本中已移除对 ``--enable-gdbgui`` 参数的支持,因此不再能通过该方式安装 `gdbgui <https://www.gdbgui.com>`_。请参考 `gdbgui 安装指南 <https://www.gdbgui.com/installation/>`_ 使用 ``pipx`` 方式进行安装。
|
||||||
|
|
||||||
|
根据操作系统和 Python 版本的不同,可能需要参考 `已知问题列表 <https://github.com/cs01/gdbgui/issues>`_。
|
||||||
|
|
||||||
|
例如,目前所有操作系统均 `不支持 Python 3.13 <https://github.com/cs01/gdbgui/issues/494>`_。
|
||||||
|
|
||||||
|
gdbgui 自 v0.14 起不再支持 Windows 操作系统。由于其他兼容性问题,Windows 下需使用 Python 3.10,并配合特定依赖版本。可通过以下命令安装已知可用的 gdbgui 及其所需版本的依赖:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pipx install "gdbgui==0.13.2.0" "pygdbmi<=0.9.0.2" "python-socketio<5" "jinja2<3.1" "itsdangerous<2.1"
|
||||||
|
```
|
||||||
|
|
||||||
|
如果操作系统为 Linux 或 macOS,可以使用 Python 3.11 或 3.12 以及 gdbgui v0.15.2.0。
|
||||||
|
|
||||||
|
请注意,以上推荐的版本可能会发生变化,请按需查阅 `官方问题追踪页面 <https://github.com/cs01/gdbgui/issues>`_ 查看最新问题列表。
|
||||||
|
|
||||||
|
如果安装过程中遇到问题,建议使用 ``idf.py gdb`` 代替 ``idf.py gdbgui``,或使用 Eclipse 或 VSCode 进行调试。
|
||||||
|
|
||||||
|
``idf.py efuse*`` 命令需要指定串口
|
||||||
|
-----------------------------------
|
||||||
|
|
||||||
|
所有 eFuse 相关命令现在都必须指定串口。这样做是为了防止意外使用错误的端口,因为这些操作是不可逆的。
|
||||||
|
|
||||||
|
对所有 ``idf.py efuse*`` 命令,需使用 ``--port`` 参数(或设置 ``ESPPORT`` 环境变量)明确指定串口。未指定时,命令将报错并终止执行。
|
||||||
|
|
||||||
|
配置文件语法变更
|
||||||
|
----------------
|
||||||
|
|
||||||
|
ESP-IDF v6 使用了 esp-idf-kconfig v3,对配置文件 ``Kconfig`` 的语法进行了若干变更。完整变更列表请参阅 `Migration Guide From esp-idf-kconfig v2.x to v3.x <https://docs.espressif.com/projects/esp-idf-kconfig/en/latest/developer-guide/migration-guide.html>`_。
|
||||||
|
Reference in New Issue
Block a user