From a8a38401f006fdaeb97896ed1c6429d0ab825eb8 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sun, 19 Jan 2020 13:11:11 +0100 Subject: [PATCH] doc: reword simplify xdebug installation/unit tests --- doc/md/Unit-tests.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md index da993109..651b546d 100644 --- a/doc/md/Unit-tests.md +++ b/doc/md/Unit-tests.md @@ -18,9 +18,9 @@ $ composer install $ composer update ``` -#### Install and enable Xdebug to generate PHPUnit coverage reports +#### Install Xdebug -See http://xdebug.org/docs/install +Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install. ```bash # for Debian-based distributions @@ -31,6 +31,7 @@ $ pacman -S xdebug ``` Then add the following line to `/etc/php/php.ini`: + ```ini zend_extension=xdebug.so ``` @@ -39,12 +40,7 @@ zend_extension=xdebug.so Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly. - -#### Test results and coverage - -By default, PHPUnit will run all suitable tests found under the `tests` directory. - -Each test has 3 possible outcomes: +By default, PHPUnit will run all suitable tests found under the `tests` directory. Each test has 3 possible outcomes: - `.` - success - `F` - failure: the test was run but its results are invalid -- 2.41.0