diff --git a/docs/en/migration-guides/release-6.x/6.0/tools.rst b/docs/en/migration-guides/release-6.x/6.0/tools.rst index 25ae808557..723ed6bdde 100644 --- a/docs/en/migration-guides/release-6.x/6.0/tools.rst +++ b/docs/en/migration-guides/release-6.x/6.0/tools.rst @@ -14,9 +14,9 @@ For example, `Python 3.13 is not supported `_. For an example of migrating from Catch2 2.x to Catch2 3.x, see commit 79a2c15477dc327550ff46a64ee0f8b4679cc417. -Dropped `idf.py size --legacy` option -------------------------------------- +Dropped ``idf.py size --legacy`` option +--------------------------------------- -The ``--legacy`` argument for ``idf.py size`` has been removed, as the legacy implementation is no longer supported. The ``ESP_IDF_SIZE_LEGACY`` environment variable has also no longer any effect. To continue using the legacy option, use ESP-IDF version 5.5 or lower. For ESP-IDF v6.0 and later, simply replace ``idf.py size --legacy`` with ``idf.py size``. If you encounter esp-idf-size version problems, please run the install script to update to the correct version. +The ``--legacy`` argument for ``idf.py size`` has been removed, as the legacy implementation is no longer supported. The ``ESP_IDF_SIZE_LEGACY`` environment variable also no longer has any effect. To continue using the legacy option, use ESP-IDF version 5.5 or lower. For ESP-IDF v6.0 and later, simply replace ``idf.py size --legacy`` with ``idf.py size``. If you encounter esp-idf-size version problems, please run the install script to update to the correct version. -Changed `idf.py size --format json` to `--format json2` -------------------------------------------------------- +Changed ``idf.py size --format json`` to ``--format json2`` +----------------------------------------------------------- The ``--format json`` option has been replaced with ``--format json2``. The ``json2`` format provides better structure with explicit ``total``, ``used``, and ``free`` fields for each memory region, and detailed breakdown in the ``parts`` section. To migrate, replace ``idf.py size --format json`` with ``idf.py size --format json2``. -- **Old format (json)**: Flat structure with direct memory type fields like ``"dram_data": 9192, "iram_text": 43295`` +- **Old format (json)**: Flat structure with direct memory type fields like ``"dram_data": 9192, "iram_text": 43295``. - **New format (json2)**: Hierarchical structure with a ``layout`` array containing memory regions: .. code-block:: json diff --git a/docs/zh_CN/api-guides/tools/idf-py.rst b/docs/zh_CN/api-guides/tools/idf-py.rst index 1c326c490e..a00bae8a4d 100644 --- a/docs/zh_CN/api-guides/tools/idf-py.rst +++ b/docs/zh_CN/api-guides/tools/idf-py.rst @@ -216,7 +216,7 @@ uf2 二进制文件也可以通过 :ref:`idf.py uf2 ` 生 选项 ^^^^^^^ -- ``--format`` 指定输出格式,可输出 ``text``、``csv``、 ``json2``、``tree``、``raw`` 格式,默认格式为 ``text``。 +- ``--format`` 指定输出格式,可输出 ``text``、``csv``、``json2``、``tree``、``raw`` 格式,默认格式为 ``text``。 - ``--output-file`` 可选参数,可以指定命令输出文件的文件名,而非标准输出。 重新配置工程:``reconfigure`` diff --git a/docs/zh_CN/migration-guides/release-6.x/6.0/tools.rst b/docs/zh_CN/migration-guides/release-6.x/6.0/tools.rst index 819f20ec17..ac390d31be 100644 --- a/docs/zh_CN/migration-guides/release-6.x/6.0/tools.rst +++ b/docs/zh_CN/migration-guides/release-6.x/6.0/tools.rst @@ -14,9 +14,9 @@ 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" -``` +.. code-block:: 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。 @@ -53,3 +53,35 @@ CMake 版本升级 如果无法升级操作系统,可以使用以下命令安装推荐的 CMake 版本:``./tools/idf_tools.py install cmake``。 此变更影响所有使用系统自带 CMake 或自定义 CMake 的 ESP-IDF 用户。 + +移除 ``idf.py size --legacy`` 选项 +------------------------------------- + +``idf.py size`` 命令的 ``--legacy`` 参数已被移除,因为旧版实现已不再受支持。``ESP_IDF_SIZE_LEGACY`` 环境变量也随之失效。如需继续使用旧版选项,请使用 ESP-IDF 5.5 或更早版本。对于 ESP-IDF v6.0 及更高版本,请直接将 ``idf.py size --legacy`` 替换为 ``idf.py size``。若遇到 esp-idf-size 版本问题,请运行安装脚本更新至正确版本。 + +更改 ``idf.py size --format json`` 为 ``--format json2`` +------------------------------------------------------------ + +``--format json`` 选项已替换为 ``--format json2``。``json2`` 格式提供了更完善的结构,为每个内存区域提供明确的 ``total``、``used`` 和 ``free`` 字段,并在 ``parts`` 部分提供详细分类。迁移时,请将 ``idf.py size --format json`` 替换为 ``idf.py size --format json2``。 + +- **旧格式 (json)**:扁平结构,内存类型字段直接列出,如 ``"dram_data": 9192, "iram_text": 43295``。 +- **新格式 (json2)**:分层结构,包含一个 ``layout`` 数组来表示内存区域: + + .. code-block:: json + + { + "version": "1.1", + "layout": [ + { + "name": "DRAM", + "total": 180736, + "used": 11344, + "free": 169392, + "parts": { + ".data": {"size": 9192}, + ".bss": {"size": 2152} + } + } + ] + } +