Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-01 20:28:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Documentation/testing: Document MemBrowse integration

Browse source 
Add a Memory Footprint Tracking section with a dashboard screenshot.

Signed-off-by: Michael Rogov Papernov <michael@membrowse.com>
This commit is contained in:
Michael Rogov Papernov 2026-06-18 21:11:01 +01:00 • committed by Alan C. Assis
parent 57eed4d904
commit 3804e3d82e
2 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
Documentation/testing/image/membrowse-targets.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 102 KiB

24
Documentation/testing/nuttx-ci.rst
View file

@ -41,6 +41,8 @@ When a PR is opened, the following CI actions take place:
* Build tests are performed based on which files were modified
* Some CI runtime tests are performed on simulators/emulators through
:doc:`/testing/ntfc`.
* Memory footprint of a set of representative targets is tracked using
`MemBrowse <https://membrowse.com>`_ (see `Memory Footprint Tracking`_).
Pull Request Labelling
======================
@ -148,3 +150,25 @@ resulting ``nuttx.bin``, ``nuttx.elf``, ``nuttx.hex``, etc., binaries. You
should be able to download the artifact, flash the NuttX image(s) to your target
device and test them that way if you'd like to avoid building all of the images
yourself!
Memory Footprint Tracking
=========================
Dashboard: `<https://membrowse.com/public/apache/nuttx>`_
The memory footprint of a set of representative targets is tracked over time
using `MemBrowse <https://membrowse.com>`_. This makes flash/RAM usage changes
visible on a per-section and per-symbol basis and helps catch unintended size
regressions. It:
* provides a trend graph of the builds across commits
* lets you compare the footprint between any two uploaded commits
* posts a footprint summary comment on each pull request
.. image:: image/membrowse-targets.png
:alt: MemBrowse targets page showing the current memory usage of each tracked NuttX target
The integration consists of:
* the set of tracked targets, configured in ``.github/membrowse-targets.json``
* the ``membrowse-*.yml`` workflows under ``.github/workflows/`` that drive it