From: Sarah Hoffmann <lonvia@denofr.de>
Date: Sun, 17 Sep 2017 18:23:40 +0000 (+0200)
Subject: improve code coverage documentation
X-Git-Tag: v3.1.0~81
X-Git-Url: https://git.openstreetmap.org/nominatim.git/commitdiff_plain/2dbf58d461ce34e56ec7334f8912fbe3e6d72132

improve code coverage documentation
---

diff --git a/test/README.md b/test/README.md
index f6c1ac2a..87782653 100644
--- a/test/README.md
+++ b/test/README.md
@@ -123,15 +123,17 @@ Before importing make sure to add the following to your local settings:
 #### Code Coverage
 
 The API tests also support code coverage tests. You need to install
-PHP_CodeCoverage. On Debian/Ubuntu run:
+[PHP_CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage).
+On Debian/Ubuntu run:
 
-    apt-get install php-codecoverage
+    apt-get install php-codecoverage php-xdebug
 
 The run the API tests as follows:
 
     behave api -DPHPCOV=<coverage output dir>
 
-To generate reports, you can use the phpcov tool:
+The output directory must be an absolute path. To generate reports, you can use
+the [phpcov](https://github.com/sebastianbergmann/phpcov) tool:
 
     phpcov merge --html=<report output dir> <coverage output dir>