From 5c150accba1ece9392213b30d84556be033d47b5 Mon Sep 17 00:00:00 2001 From: Nick Wellnhofer Date: Fri, 29 Sep 2023 16:07:45 +0200 Subject: [PATCH] doc: Add notes about runtest to MAINTAINERS.md --- MAINTAINERS.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 9bbca3e1..c5000dbd 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,5 +1,17 @@ # Maintainer's Guide +## Working with the test suite + +Most of the tests are contained in the `runtest` executable which +generally reads test cases from the `test` directory and compares output +to files in the `result` directory. + +You can simply add new test cases and run `runtest -u` to update the +results. If you debug test failures, it's also useful to execute +`runtest -u` and then `git diff result` to get a diff between actual and +expected results. You can restore the original results by running +`git restore result` and `git clean -xd result`. + ## Generated files The documentation and other generated files can be rebuilt by running