zephyr

History

Benjamin Cabé 59e4c5aed0 samples: fully migrate basic samples to the new Sphinx extension - Updated basic samples READMEs to use the new zephyr:code-sample:: directive. Dropped "-sample" suffix that's not required anymore now that samples have their own namespace. - Updated all references to the samples to use the :zephyr:code-sample: role. Checked and updated the wording of said references to account for the fact that samples should not have "... sample" in their name anymore. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2023-09-13 09:15:34 +02:00
..
src	samples/basic: print_sys_memory_stats() removed from hash_map, static	2023-08-22 19:12:59 -04:00
CMakeLists.txt
prj.conf
README.rst	samples: fully migrate basic samples to the new Sphinx extension	2023-09-13 09:15:34 +02:00
sample.yaml	samples, tests: convert string-based twister lists to YAML lists	2023-05-10 09:52:37 +02:00

README.rst

.. zephyr:code-sample:: sys-heap
   :name: System heap

   Print system heap usage to the console.

Overview
********

A simple sample that can be used with any :ref:`supported board <boards>` and
prints system heap usage to the console.

Building
********************

This application can be built on native_posix as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/basic/sys_heap
   :host-os: unix
   :board: native_posix
   :goals: build
   :compact:

To build for another board, change "native_posix" above to that board's name.

Running
*******

Run build/zephyr/zephyr.exe

Sample Output
*************

.. code-block:: console

    System heap sample

    allocated 0, free 196, max allocated 0, heap size 256
    allocated 156, free 36, max allocated 156, heap size 256
    allocated 100, free 92, max allocated 156, heap size 256
    allocated 0, free 196, max allocated 156, heap size 256