From 6f97a18e445b82eb8ceee06aab8f62330aecbd61 Mon Sep 17 00:00:00 2001 From: Frantisek Hrbata Date: Thu, 22 Aug 2024 13:04:47 +0200 Subject: [PATCH] docs(size): remove -DOUTPUT_FORMAT output format option for idf.py size Setting OUTPUT_FORMAT through the CMake variable probably never functioned and seems to be a remnant (possibly a typo in the documentation) from the time when the -DOUTPUT_JSON=1 CMake variable was used to specify the JSON output format, prior to the introduction of the --format option. This removes the note regarding the option to choose the output format using -DOUTPUT_FORMAT. Closes https://github.com/espressif/esp-idf/issues/14383 Signed-off-by: Frantisek Hrbata --- docs/en/api-guides/performance/size.rst | 4 ---- docs/zh_CN/api-guides/performance/size.rst | 4 ---- 2 files changed, 8 deletions(-) diff --git a/docs/en/api-guides/performance/size.rst b/docs/en/api-guides/performance/size.rst index c48eb3309f..0e132de012 100644 --- a/docs/en/api-guides/performance/size.rst +++ b/docs/en/api-guides/performance/size.rst @@ -18,10 +18,6 @@ To optimize both the firmware binary size and the memory usage, it is necessary Using the :ref:`idf.py` sub-commands ``size``, ``size-components``, and ``size-files`` provides a summary of memory used by the project: -.. note:: - - It is possible to add ``-DOUTPUT_FORMAT=csv`` or ``-DOUTPUT_FORMAT=json`` to get the output in CSV or JSON format. - Size Summary ``idf.py size`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/zh_CN/api-guides/performance/size.rst b/docs/zh_CN/api-guides/performance/size.rst index 86eec89b68..f690589f54 100644 --- a/docs/zh_CN/api-guides/performance/size.rst +++ b/docs/zh_CN/api-guides/performance/size.rst @@ -18,10 +18,6 @@ ESP-IDF 构建系统会编译项目和 ESP-IDF 中所有源文件,但只有程 使用 :ref:`idf.py` 的子命令 ``size``, ``size-components`` 和 ``size-files`` 可以输出项目使用内存概况: -.. note:: - - 添加 ``-DOUTPUT_FORMAT=csv`` 或 ``-DOUTPUT_FORMAT=json``,即可用 CSV 或 JSON 格式输出文件。 - 数据大小概况 ``idf.py size`` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^