Commit graph

28 commits

Author SHA1 Message Date
Marco Casaroli
1f3358e991 Documentation: Document the xipfs command, test suite and NXFLAT demo.
Pages for the three applications that come with xipfs: the command that
compacts a volume and prints its block map, the test suite and what each of
its sections covers, and the demo that downloads an NXFLAT module into a
volume and runs two instances of it in place.

Assisted-by: Claude Code:claude-opus-5
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
2026-07-29 07:49:03 -03:00
hanzhijian
fd86d4de1a Documentation: describe drivertest coverage
Explain how drivertest applications are selected and run, list the current test categories, and document the watchdog reset and notifier test behavior.

Assisted-by: OpenAI Codex
Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-07-17 14:59:47 +08:00
Saurav Pal
4f6e695f7c fs/mnemofs: Add mnemofs version 1 support.
Split mnemofs into allocation, directory, file, CTZ, and read/write
modules, and update direntry traversal and file handling. Add superblock
format version 1 support, reject newer on-flash versions, and preserve
the mounted version when rewriting metadata.

Update the NAND simulator drivers for the new mnemofs behavior by fixing
spare writes, exposing the erase state, allowing raw reads, and documenting
the background-task startup flow.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
2026-05-19 10:29:11 +08:00
Tomasz 'CeDeROM' CEDRO
3efaf80d3d boards/xtensa/esp32s3: New board WaveShare ESP32-S3-Touch-LCD-1.28 (WIP).
* Initial experimental / work in progress implementation.
* New board name is esp32s3-ws-lcd128.
* Supports Kconfig delectable w/wo touch variants (lcd gpios difference).
* IMU QMI8658 bringups is put into esp32s3/common/src to share with other
  boards. Pin defines are located at <board>include/board.h and referenced
  with `#include <arch/board/board.h>`.
* Supported configurations: nsh, ostest, coremark, touch-lvgl, notouch-lvgl,
  imu-qmi8658, watchdog.
* Does not have touch panel driver yet.
* Created board documentation. Added sphinx inline cross-references.
* TODO: Fix SPI GC9A01A LCD pixel format colors.
* TODO: Create I2C CST816S touch panel driver.

Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2026-04-24 16:27:08 +08:00
Matteo Golin
0885b324a1 docs/cmocka: Fill out documentation for cmocka
Write documentation for cmocka.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2025-12-29 19:16:21 +08:00
Matteo Golin
18a5ec8410 docs/testing/nuts: Include preliminary documentation for NUTS
Documentation for the NuttX Unit Test Selection (NUTS) app. Includes
information about the configuration options, build dependencies,
currently included test cases and how to extend the test collection with
new unit tests.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2025-12-27 20:43:32 +08:00
zhangshuai39
b09d402d06 nettest: Add a guide document for the nettest directory.
Signed-off-by: zhangshuai39 <zhangshuai39@xiaomi.com>
2025-12-18 21:46:43 +08:00
Alan Carvalho de Assis
c84e2ebfa9 doc: Add documentation to pthread_mutex_perf application
Signed-off-by: Alan C. Assis <acassis@gmail.com>
2025-12-16 20:57:44 -03:00
trns1997
d7b2df6d85 ci/cxx: Add out-of-tree build CI test.
Introduce a new CI test to validate out-of-tree builds
and prevent regressions in the `make export` workflow.
Specifically, this change adds `test-oot-build.sh` that:
* Builds NuttX using a selected configuration.
* Runs `make export` to generate the export package.
* Copies the `nuttx-export` to the OOT build project.
* Verifies that compilation and linking succeed.

Signed-off-by: trns1997 <trns1997@gmail.com>
2025-09-27 21:36:22 +08:00
Matteo Golin
c152f178f9 docs/unity: Improved documentation for using Unity testing framework
The documentation for using the Unity testing framework previously just
linked to the official Unity website. In using Unity, I noticed there
were much more extensive docs on the actual GitHub page. This PR
includes references to those docs and also provides a short-winded
explanation of how to make a Unity test suite on NuttX.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2025-08-07 16:11:29 +08:00
Matteo Golin
1107d4183c docs/getprime: Add documentation for getprime example.
Added documentation for `getprime` example as part of #11081.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2025-05-26 10:51:51 -03:00
Lars Kruse
b333ad3ab5 style: fix typos
Thanks, codespell!
2025-04-30 13:45:46 +08:00
buxiasen
3164f201fb document/drivertest: add more information in drivertest
Signed-off-by: buxiasen <buxiasen@xiaomi.com>
2024-12-11 00:33:48 +08:00
chenrun1
52f381fdd4 Adjust the apps/benchmarks directory and add some new Profile tools
Based on the adjustment of https://github.com/apache/nuttx-apps/pull/2346, update the Document

Signed-off-by: chenrun1 <chenrun1@xiaomi.com>
2024-04-07 18:49:16 +08:00
Saurav Pal
1bec133385 drivers/mtd/mtd_nandram: Adds virtual NAND Flash device simulator.
Adds virtual NAND Flash device simulator, NAND flash log wrapper, and documentation for it.

Signed-off-by: Saurav Pal <resyfer.dev@gmail.com>
2024-03-04 10:38:08 -03:00
Michal Lenc
34afef5cfb Documentation: add open_memstream test entry
Test tool for open_memstream() function added to documentation.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2023-11-27 03:24:53 -08:00
Stuart Ianna
90cf37a179 Documentation: Fix sd_bench command help description.
The help prompt usage output for sd_bench was inconsistent with that of
the actual application. Amend this error.
2023-11-16 22:52:30 -08:00
Stuart Ianna
fe468b276e Documentation: Add entry for sd_bench tool. 2023-10-26 09:00:29 +08:00
crafcat7
3d78859737 applications:Move the test tools in the system directory to the testing directory.
by pr#2161

The following four tools were moved:
1.memstress
2.ramtest
3.ramspeed
4.cachespeed

Signed-off-by: crafcat7 <crafcat7@outlook.com>
2023-10-26 00:09:28 +08:00
raiden00pl
afef047c6f Documentation: fix warning introduced by sd_stress
nuttx/Documentation/applications/testing/sd_stress/index.rst:1: WARNING: Title overline too short.
2023-10-26 00:08:54 +08:00
Stuart Ianna
c19c943835 Documentation: Add entry for sd_stress tool. 2023-10-25 09:16:50 +08:00
raiden00pl
d1ebe6cd24 Documentation: add dummy apps descriptions
The apps description is empty for now but allows to generate nice tables of content with all nuttx-apps functionalities.
2023-10-25 00:25:58 +08:00
raiden00pl
abdcc8d17c Documentation: unify applications/xxx/index.rst 2023-10-24 10:29:01 -03:00
raiden00pl
931096f3f6 Documentation: various cosmetic changes 2023-10-24 10:29:01 -03:00
Michal Lenc
8f042f527e Documentation: add fmemopen test entry
Test tool for fmemopen() function added to documentation.

Signed-off-by: Michal Lenc <michallenc@seznam.cz>
2023-10-24 10:28:01 -03:00
raiden00pl
a342d2a7ac Documentaion: migrate testing readmes 2023-10-24 13:56:34 +08:00
raiden00pl
e93eb76017 Documentation: list all supported libs tools and apps 2023-10-23 19:52:53 +08:00
raiden00pl
131f4151b7 Documentation: reflects the structure of nuttx-apps 2023-10-23 19:52:53 +08:00