From d9bddc35a1fe16cb737f9499873c38893a3f0c73 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Sun, 23 Jun 2019 17:58:27 -0400 Subject: [PATCH] docs: Add information on running the regression suite locally Signed-off-by: Kevin O'Connor --- docs/Debugging.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/Debugging.md b/docs/Debugging.md index 6158ec85..605c288b 100644 --- a/docs/Debugging.md +++ b/docs/Debugging.md @@ -174,3 +174,24 @@ The script will extract the printer config file and will extract MCU shutdown information. The information dumps from an MCU shutdown (if present) will be reordered by timestamp to assist in diagnosing cause and effect scenarios. + +Running the regression tests +============================ + +The main Klipper GitHub repository uses TravisCI to run a series of +regression tests. It can be useful to run some of these tests locally. + +The source code "whitespace check" can be run with: +``` +./scripts/check_whitespace.sh +``` + +The Klippy regression test suite requires "data dictionaries" from +many platforms. The easiest way to obtain them is to +[download them from github](https://github.com/KevinOConnor/klipper/issues/1438). +Once the data dictionaries are downloaded, use the following to run +the regression suite: +``` +tar xfz klipper-dict-20??????.tar.gz +~/klippy-env/bin/python ~/klipper/scripts/test_klippy.py -d dict/ ~/klipper/test/klippy/*.test +```