aboutsummaryrefslogtreecommitdiffstats
path: root/pkg-test/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'pkg-test/README.md')
-rw-r--r--pkg-test/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/pkg-test/README.md b/pkg-test/README.md
new file mode 100644
index 00000000..95f7ecb8
--- /dev/null
+++ b/pkg-test/README.md
@@ -0,0 +1,14 @@
+# Tests for installed packages
+
+The files in this directory are called by autopkgtest in the debian package but can be used by any packager to verify installed packages. Each test-* script should be run from the top of the source tree and takes an empty directory as its single argument. The test passes if the script exits with a zero exit status. Note that these tests write to stderr because they use set -x in the shell.
+
+On a GNU/Linux system, you can run `./pkg-test/run-all` from the top-level directory to run all the tests. For example:
+
+```
+cmake -S . -B build
+cmake --build build -j$(nproc)
+DESTDIR=/tmp/inst cmake --install build
+env PKG_CONFIG_PATH=/tmp/inst/usr/local/lib/pkgconfig \
+ CMAKE_PREFIX_PATH=/tmp/inst/usr/local \
+ ./pkg-test/run-all
+```