diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 61 |
1 files changed, 56 insertions, 5 deletions
@@ -138,6 +138,24 @@ dep_ct_helper = git https://github.com/extend/ct_helper.git master Please note that the test dependencies will only be compiled once when they are fetched, unlike the normal dependencies. +Autopatch +--------- + +The autopatch features allows you to automatically fix packages +that are not compatible with erlang.mk. It can also be used to +convert compatible packages to use erlang.mk itself for building +when used as dependency. + +The patching occurs only once, immediately after the package has +been fetched. + +erlang.mk defines a number of packages to be patched. You can add +more packages to the list by appending the `AUTOPATCH` variable. + +``` Makefile +AUTOPATCH += gproc +``` + Releases -------- @@ -215,12 +233,18 @@ Cloning into '/home/essen/ninenines/cowboy/deps/ranch'... Cloning into '/home/essen/ninenines/cowboy/deps/cowlib'... ``` +The `-O` option will ensure that output from different +targets is grouped, which is particularly useful when +running tests with different frameworks at the same time. +The disadvantage of this option however is that there is +no output until the target is completed. + The``MAKEFLAGS` variable can be used to set it permanently on your system. It can be set in your `.zshrc`, `.bashrc` or equivalent file. ``` bash -MAKEFLAGS=-j32 +MAKEFLAGS="-j32 -O" ``` Core package functionality @@ -252,6 +276,9 @@ You can change compilation options by setting the `ERLC_OPTS` variable. It takes the arguments that will then be passed to `erlc`. For more information, please see `erl -man erlc`. +Test target compilation options can be specified in `TEST_ERLC_OPTS`. +It will override `ERLC_OPTS`. + You can specify a list of modules to be compiled first using the `COMPILE_FIRST` variable. @@ -325,7 +352,10 @@ The defaults are system dependent. Common_test plugin ------------------ -This plugin is available by default. +This plugin is available by default. It adds the following +target: + +`ct` runs all test suites for this application. There is nothing to configure to use it, simply create your test suites in the `./test/` directory and erlang.mk will @@ -438,9 +468,8 @@ EUnit plugin This plugin is available by default. It adds the following target: -`eunit` which runs all the EUnit tests found in `ebin` and -any of the additional EUnit directories specified in -`EUNIT_DIR`. +`eunit` which runs all the EUnit tests found in `ebin` or +the test directory specified in `TEST_DIR`. `EUNIT_OPTS` can be used to specify EUnit-specific options (e.g. `verbose`) that will be used when calling @@ -487,6 +516,28 @@ For more information please see `erl -man erl`. `SHELL_PATH` adds paths to the shell's library search path. By default this option sets the paths to `-pa ../$(PROJECT)/ebin $(DEPS_DIR)/*/ebin`. +Triq plugin +----------- + +This plugin is available by default. It adds the following +target: + +`triq` will check all the properties found in `ebin` or +the test directory specified in `TEST_DIR`. + +You can use the `t` variable to give a specific module +or function to run, for example: + +``` bash +$ make triq t=cow_http_hd +``` + +Or: + +``` bash +$ make triq t=cow_http_hd:prop_parse_accept +``` + Contributing ------------ |