diff options
author | José Valim <jose.valim@plataformatec.com.br> | 2019-01-29 09:04:16 +0100 |
---|---|---|
committer | José Valim <jose.valim@plataformatec.com.br> | 2019-01-29 09:04:16 +0100 |
commit | ca7d95f005afb1979a9fcf58325953ad565e9eec (patch) | |
tree | 4866647cf1d13f1e5459b329ba8890cf1eb5d92d | |
parent | 3078f1a87b6820c3e2a14a3fcd08bf85c86d7741 (diff) | |
download | elixir-ca7d95f005afb1979a9fcf58325953ad565e9eec.tar.gz |
Clarify include_erts option
-rw-r--r-- | lib/mix/lib/mix/tasks/release.ex | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/mix/lib/mix/tasks/release.ex b/lib/mix/lib/mix/tasks/release.ex index 2c49d7712..031aa8c43 100644 --- a/lib/mix/lib/mix/tasks/release.ex +++ b/lib/mix/lib/mix/tasks/release.ex @@ -275,10 +275,11 @@ defmodule Mix.Tasks.Release do * `:quiet` - a boolean that controls if releases should write to the standard output its steps. Defaults to `false`. - * `:include_erts` - a boolean indicating if the Erlang Runtime System (ERTS) - should be included in the release. The default is `true`, which is also the - recommended value. It may also be a path to an existing ERTS installation or - an anonymous function of zero arity which should return any of the above. + * `:include_erts` - a boolean indicating if the Erlang Runtime System (ERTS), + which includes the ERlang VM, should be included in the release. The default + is `true`, which is also the recommended value. It may also be a string as a + path to an existing ERTS installation or an anonymous function of zero arity + which should return any of the above. You may also set it to `false` if you desire to use the ERTS version installed on the target. Note, however, the ERTS version on the target must have THE EXACT |