diff options
| author | nodiscc <nodiscc@gmail.com> | 2020-01-19 13:11:11 +0100 |
|---|---|---|
| committer | nodiscc <nodiscc@gmail.com> | 2020-01-19 13:11:11 +0100 |
| commit | a8a38401f006fdaeb97896ed1c6429d0ab825eb8 (patch) | |
| tree | 371d47a897ca80ccb17b95572f591a9f5fd75f7a | |
| parent | 7a7a5237822207171e535fc00de253fbfd25c5a2 (diff) | |
| download | Shaarli-a8a38401f006fdaeb97896ed1c6429d0ab825eb8.tar.gz Shaarli-a8a38401f006fdaeb97896ed1c6429d0ab825eb8.tar.zst Shaarli-a8a38401f006fdaeb97896ed1c6429d0ab825eb8.zip | |
doc: reword simplify xdebug installation/unit tests
| -rw-r--r-- | doc/md/Unit-tests.md | 12 |
1 files 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 | |||
| 18 | $ composer update | 18 | $ composer update |
| 19 | ``` | 19 | ``` |
| 20 | 20 | ||
| 21 | #### Install and enable Xdebug to generate PHPUnit coverage reports | 21 | #### Install Xdebug |
| 22 | 22 | ||
| 23 | See http://xdebug.org/docs/install | 23 | Xdebug must be installed and enable for PHPUnit to generate coverage reports. See http://xdebug.org/docs/install. |
| 24 | 24 | ||
| 25 | ```bash | 25 | ```bash |
| 26 | # for Debian-based distributions | 26 | # for Debian-based distributions |
| @@ -31,6 +31,7 @@ $ pacman -S xdebug | |||
| 31 | ``` | 31 | ``` |
| 32 | 32 | ||
| 33 | Then add the following line to `/etc/php/php.ini`: | 33 | Then add the following line to `/etc/php/php.ini`: |
| 34 | |||
| 34 | ```ini | 35 | ```ini |
| 35 | zend_extension=xdebug.so | 36 | zend_extension=xdebug.so |
| 36 | ``` | 37 | ``` |
| @@ -39,12 +40,7 @@ zend_extension=xdebug.so | |||
| 39 | 40 | ||
| 40 | Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly. | 41 | Run `make test` and ensure tests return `OK`. If tests return failures, refer to PHPUnit messages and fix your code/tests accordingly. |
| 41 | 42 | ||
| 42 | 43 | By default, PHPUnit will run all suitable tests found under the `tests` directory. Each test has 3 possible outcomes: | |
| 43 | #### Test results and coverage | ||
| 44 | |||
| 45 | By default, PHPUnit will run all suitable tests found under the `tests` directory. | ||
| 46 | |||
| 47 | Each test has 3 possible outcomes: | ||
| 48 | 44 | ||
| 49 | - `.` - success | 45 | - `.` - success |
| 50 | - `F` - failure: the test was run but its results are invalid | 46 | - `F` - failure: the test was run but its results are invalid |