Skip to content

Commit a8958f0

Browse files
committed
Improve release docs
1 parent 59bf224 commit a8958f0

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

lib/mix/lib/mix/tasks/release.ex

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,7 @@ defmodule Mix.Tasks.Release do
5757
the VM will find the `Enum` module and load it. There's a downside:
5858
when you start a new server in production, it may need to load
5959
many other modules, causing the first requests to have an unusual
60-
spike in response time. With releases, the system is configured in
61-
interactive mode and then it swaps to embedded mode, which preloads
60+
spike in response time. With releases, the system preloads
6261
all modules and guarantees your system is ready to handle requests
6362
after booting.
6463
@@ -652,17 +651,16 @@ defmodule Mix.Tasks.Release do
652651
The following options can be set inside your releases key in your `mix.exs`
653652
to control how config providers work:
654653
655-
* `:reboot_system_after_config` - every time your release is configured,
656-
the system is rebooted to allow the new configuration to take place.
657-
You can set this option to `false` to disable the rebooting for applications
658-
that are sensitive to boot time but, in doing so, note you won't be able
659-
to configure system applications, such as `:kernel` and `:stdlib`.
660-
When set to `true` the computed config file will be written to the "tmp"
661-
directory inside the release every time the system boots. You can configure
662-
the "tmp" directory by setting the `RELEASE_TMP` environment variable, either
663-
explicitly or inside your `releases/RELEASE_VSN/env.sh` (or `env.bat` on Windows).
664-
Defaults to `true` if using the deprecated `config/releases.exs`,
665-
`false` otherwise.
654+
* `:reboot_system_after_config` - reboot the system after configuration
655+
so you can configure system applications, such as `:kernel` and `:stdlib`,
656+
in your `config/runtime.exs`. Generally speaking, it is best to configure
657+
`:kernel` and `:stdlib` using the `vm.args` file but this option is available
658+
for those who need more complex configuration. When set to `true` the computed
659+
config file will be written to the "tmp" directory inside the release every time
660+
the system boots. You can configure the "tmp" directory by setting the
661+
`RELEASE_TMP` environment variable, either explicitly or inside your
662+
`releases/RELEASE_VSN/env.sh` (or `env.bat` on Windows). Defaults to `true`
663+
if using the deprecated `config/releases.exs`, `false` otherwise.
666664
667665
* `:prune_runtime_sys_config_after_boot` - if `:reboot_system_after_config`
668666
is set, every time your system boots, the release will write a config file

0 commit comments

Comments
 (0)