Explanation on what arguments are for what mode

tot-ra 2014-11-13 07:53:56 -08:00
commit 342d50859c

@ -1,13 +1,18 @@
Runs PHPUnit tests against your build.
Has two modes:
### Configuration Options:
* **directory** - Optional - The directory (or array of dirs) to run PHPUnit on
### With phpunit.xml configuration file
Its activated if you have phpunit.xml file in your build path, `tests/` subfolder, or you specify it as a parameter:
* **config** - Optional - Path to a PHP Unit XML configuration file.
* **run_from** - Optional - When running PHPUnit with an XML config, the command is run from this directory
* **path** - Optional - In cases where tests files are in a sub path of the /tests path, allows this path to be set in the config.
* **args** - Optional - Command line args (in string format) to pass to PHP Unit
* **coverage** - Optional - Value for the `--coverage-html` command line flag.
* **path** - Optional - In cases where tests files are in a sub path of the /tests path, allows this path to be set in the config.
### Running tests in directory by listing it.
* **directory** - Optional - The directory (or array of dirs) to run PHPUnit on
Both modes accept:
* **args** - Optional - Command line args (in string format) to pass to PHP Unit
### Examples
Specify config file and test directory: