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 <[email protected]>
  • Loading branch information
fhrbata committed Sep 4, 2024
1 parent 220f9e6 commit e08cde2
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions docs/en/api-guides/performance/size.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ To optimize both firmware binary size and memory usage it's necessary to measure

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

0 comments on commit e08cde2

Please sign in to comment.