diff options
| author | Loïc Hoguin <[email protected]> | 2018-11-28 15:33:45 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-11-28 15:33:45 +0100 |
| commit | f02b4285f65acdbbe7d9d9905a3f5e6bd91bff1f (patch) | |
| tree | 599d29e05d12fdbb535e69ae7e3c83d9cb0e967a | |
| parent | ba993a77b80569971d1c64a9e4634f7b5be8bdde (diff) | |
| download | erlang.mk-f02b4285f65acdbbe7d9d9905a3f5e6bd91bff1f.tar.gz erlang.mk-f02b4285f65acdbbe7d9d9905a3f5e6bd91bff1f.tar.bz2 erlang.mk-f02b4285f65acdbbe7d9d9905a3f5e6bd91bff1f.zip | |
Document parallel building
| -rw-r--r-- | README.legacy.md | 48 | ||||
| -rw-r--r-- | doc/src/guide/app.asciidoc | 14 |
2 files changed, 14 insertions, 48 deletions
diff --git a/README.legacy.md b/README.legacy.md index 59d74d1..38b90e3 100644 --- a/README.legacy.md +++ b/README.legacy.md @@ -4,54 +4,6 @@ Old Erlang.mk documentation This documentation reminds here until it gets moved to the official documentation on http://erlang.mk/guide/. -Extending Erlang.mk -------------------- - -You may add additional operations to them by using the double -colons. Make will run all targets sharing the same name when -invoked. - -``` Makefile -clean:: - @rm anotherfile -``` - -You can enable verbose mode by calling Make with the variable -`V` set to 1. - -``` bash -$ make V=1 -``` - -Parallel execution ------------------- - -*Parallel execution is currently enabled (experimental).* - -Parallel execution can be enabled through the use of the -`-j` option. The following output showcases concurrent -downloading of dependencies. - -``` bash -$ make -j32 -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 -O" -``` - ErlyDTL plugin -------------- diff --git a/doc/src/guide/app.asciidoc b/doc/src/guide/app.asciidoc index 9d5e948..226f24c 100644 --- a/doc/src/guide/app.asciidoc +++ b/doc/src/guide/app.asciidoc @@ -25,6 +25,20 @@ and conventions. Most of the conventions come from Erlang/OTP itself so any seasoned Erlang developers should feel right at home. +Erlang.mk supports multi-threaded building. Parallel execution +is supported for all targets. To execute Erlang.mk in parallel +the `-j` option must be used: + +[source,bash] +$ make -j8 + +The `MAKEFLAGS` variable can be used to enable parallel +building permanently on your system. It can be set in +your `.zshrc`, `.bashrc` or equivalent file. + +[source,bash] +MAKEFLAGS="-j8" + === What to build Erlang.mk gives you control over three steps of the build |