Skip to content

Commit

Permalink
docs(size): remove -DOUTPUT_FORMAT output format option for idf.py size
Browse files Browse the repository at this point in the history
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 #14383

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
  • Loading branch information
fhrbata committed Aug 22, 2024
1 parent 0bbd728 commit 6f97a18
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 8 deletions.
4 changes: 0 additions & 4 deletions docs/en/api-guides/performance/size.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
4 changes: 0 additions & 4 deletions docs/zh_CN/api-guides/performance/size.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 6f97a18

Please # to comment.