From 93502561349e922fdac00ef5636c8ef063f92d43 Mon Sep 17 00:00:00 2001 From: Laszlo Ersek Date: Thu, 9 Mar 2023 11:30:23 +0100 Subject: [PATCH] HACKING.md: describe testing (#796) The top-level HACKING document is inexplicably silent on how bugs can be reproduced/triggered and how fixes/features can be verified. That's an unnecessary difficulty for anyone new trying to contribute to augeas. Document "make check", and highlight the difference between "test-get.sh" and the individual lens tests under "lenses/tests/". Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=2155147 Signed-off-by: Laszlo Ersek --- HACKING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/HACKING.md b/HACKING.md index efd993d7a..b04dde98b 100644 --- a/HACKING.md +++ b/HACKING.md @@ -28,7 +28,7 @@ At its simplest, you build Augeas from git by running the following commands in the toplevel directory of your Augeas checkout: ./autogen.sh [--gnulib-srcdir=$GNULIB_CHECKOUT] - make && make install + make && make check && make install It is recommended though to turn on a few development features when building; in particular, stricter compiler warnings and some debug @@ -54,6 +54,12 @@ to augtool verbatim * `./src/try valgrind`: run the commands from `build/augcmds.txt` through augtool under valgrind to check for memory leaks +Furthermore, the test suite invoked with `make check` includes a test +called `test-get.sh`, which ensures that reading the files in +`tests/root/` with `augtool` does not lead to any errors. (It does not +verify the parsed syntax tree however; you'll have to extend the +individual lens tests under `lenses/tests/` for that.) + # Platform specific notes ## Mac OSX