Commit 8d61b363 authored by Pieter De Gendt's avatar Pieter De Gendt Committed by Henrik Brix Andersen
Browse files

doc: develop: optimizations: tools: Add ram_plot/rom_plot targets 



Add information about the ram_plot and rom_plot build targets to generate
memory usage reports using sunburst charts.

Signed-off-by: default avatarPieter De Gendt <pieter.degendt@basalte.be>
parent aea45b9e

doc/develop/optimizations/ram_plot.png

0 → 100644
+41.2 KiB
Loading image diff...

doc/develop/optimizations/rom_plot.png

0 → 100644
+60.5 KiB
Loading image diff...

doc/develop/optimizations/tools.rst

+34 −0
Original line number Diff line number Diff line
@@ -157,6 +157,40 @@ These commands will generate something similar to the output below:: 
    ========================================================================================

                                                                  21652





Build Targets: ram_plot/rom_plot

================================



Similar to the ``ram_report`` and ``rom_report`` build targets, these targets generate memory usage

reports in a sunburst chart as a visual representation.

A user can click on segments to navigate through the directory structures, and hover over segments

to get more details.



Running the targets will first generate the CLI report and then open a browser window.



.. zephyr-app-commands::

    :tool: all

    :zephyr-app: samples/hello_world

    :board: reel_board

    :goals: ram_plot



.. image:: ram_plot.png

   :align: center

   :alt: RAM usage sunburst chart



And similarly for the ROM usage.



.. zephyr-app-commands::

    :tool: all

    :zephyr-app: samples/hello_world

    :board: reel_board

    :goals: rom_plot



.. image:: rom_plot.png

   :align: center

   :alt: ROM usage sunburst chart





Build Target: puncover

======================

CRA Git | Maintained and supported by SUSTech CRA and CCSE