This is an automated email from the git hooks/post-receive script.
vapier pushed a commit to branch master
in repository libtool.
The following commit(s) were added to refs/heads/master by this push:
new 23eacf88 HACKING: add more test related tips
23eacf88 is described below
commit 23eacf882e5247d95360740fd8742eec14146720
Author: Mike Frysinger <[email protected]>
AuthorDate: Thu Jan 18 01:37:11 2024 -0500
HACKING: add more test related tips
* HACKING: Document syntax-check & distcheck & parallel testing.
---
HACKING | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
diff --git a/HACKING b/HACKING
index 664251e6..38401c9c 100644
--- a/HACKING
+++ b/HACKING
@@ -24,6 +24,14 @@ and is not part of a release distribution.
that demonstrates the bug. Then fix the bug, re-run the test suite,
and check everything in.
+* Always run the testsuite after applying a patch:
+ make check syntax-check TESTSUITEFLAGS="--jobs=$(nproc)" -j$(nproc)
+
+ Ideally also verify the release process doesn't break:
+ make distcheck TESTSUITEFLAGS="--jobs=$(nproc)" -j$(nproc)
+ This will run check & syntax-check from above, but will take longer as
+ builds & tests in different configurations.
+
* Some files in the libtool package are not owned by libtool. These
files should never be edited here. These files are:
COPYING
@@ -55,13 +63,17 @@ and is not part of a release distribution.
AT_CHECK) is on a single line so that 'testsuite -x' displays the
whole thing. You can use m4_do or '[... ]dnl' to wrap long lines.
-* Use
- make -k check
+* Run tests in parallel with
+ make -k check TESTSUITEFLAGS="--jobs=$(nproc)"
liberally, on as many platforms as you can. Use as many compilers and
linkers you can. To run old and new testsuites separately, use:
make check TESTSUITEFLAGS=-V
make check-local
+* The gnulib module also provides some maintainer-focused tests that only
+ work when run from a git checkout.
+ make syntax-check
+
* The new Autotest testsuite uses keywords to denote test features:
autoconf needs Autoconf
automake needs Automake
