From f55520380da00985015180be4a5da554c461645b Mon Sep 17 00:00:00 2001 From: Brian Pugh Date: Thu, 27 Feb 2025 17:41:29 -0800 Subject: [PATCH] Add a little bit of documentation on how to run tests. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index a1dc7437..4c79c5df 100644 --- a/README.md +++ b/README.md @@ -199,6 +199,18 @@ The tests assume a Linux environment and can be started with make: make test ``` +Tests are defined as C code in toml files in the `tests/` directory. +When developing a feature or fixing a bug, it is frequently useful to run a single suite of tests. +To run individual tests or suite of tests: + +``` bash +make test-runner +python scripts/test.py --help # See all available options +python scripts/test.py --list-suites # prints out all available test suites. +python scripts/test.py --list-cases # prints out all available individual test cases. +python scripts/test.py runners/test_runner test_attrs # runs the test_attrs suite. +``` + ## License The littlefs is provided under the [BSD-3-Clause] license. See