summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Kalnischkies <david@kalnischkies.de>2016-09-02 14:19:54 +0200
committerDavid Kalnischkies <david@kalnischkies.de>2016-09-03 16:02:53 +0200
commit7ce2af82bb83a9f46df560db601a028024dc1567 (patch)
tree92e030f09c0dbaa5492050615f50ec9c8518b93c
parent54dd6baaf16e92c83f63bdb3633df6e603ac19f3 (diff)
downloadapt-7ce2af82bb83a9f46df560db601a028024dc1567.tar.gz
update testing hints in README.md
Gbp-Dch: Ignore
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index 981e878a0..5c8fb1ad0 100644
--- a/README.md
+++ b/README.md
@@ -98,15 +98,27 @@ Testing
When you make changes and want to run them manually, you can just do so. CMake
automatically inserts an rpath so the binaries find the correct libraries.
+Note that you have to invoke CMake with the right install prefix set (e.g.
+`-DCMAKE_INSTALL_PREFIX=/usr`) to have your build find and use the right files
+by default or alternatively set the locations at runtime via an `APT_CONFIG`
+configuration file.
+
### Integration tests
-There is a extensive integration testsuite available which can be run via:
+There is an extensive integration testsuite available which can be run via:
$ ./test/integration/run-tests
-While these tests are not executed at package build-time as they require additional
-dependencies, the repository contains the configuration needed to run them on [Travis CI](https://travis-ci.org/)
-as well as via autopkgtests e.g. on [Debian Continuous Integration](http://ci.debian.net/?q=apt#package/apt).
+Each test can also be run individually as well. The tests are very noisy by
+default, especially so while running all of them it might be beneficial to
+enabling quiet (`-q`) or very quiet (`-qq`) mode. The tests can also be run in
+parallel via `-j X` where `X` is the number of jobs to run.
+
+While these tests are not executed at package build-time as they require
+additional dependencies, the repository contains the configuration needed to
+run them on [Travis CI](https://travis-ci.org/) and
+[Shippable](https://shippable.com/) as well as via autopkgtests e.g. on
+[Debian Continuous Integration](https://ci.debian.net/packages/a/apt/).
A testcase here is a shellscript embedded in a framework creating an environment in which
apt tools can be used naturally without root-rights to test every aspect of its behavior
@@ -129,7 +141,7 @@ in certain areas. The following describes some common scenarios and generally
useful options, but is in no way exhaustive.
Note that you should *NEVER* use these settings as root to avoid accidents.
-Similation mode (`-s`) is usually sufficient to help you run apt as a non-root user.
+Simulation mode (`-s`) is usually sufficient to help you run apt as a non-root user.
### Using different state files