Prefer Application.put_all_env/2 on Mix.install/2

1 files changed, 5 insertions, 4 deletions

diff --git a/lib/mix/lib/mix.ex b/lib/mix/lib/mix.ex
index 26f4c663f..2879249c4 100644
--- a/lib/mix/lib/mix.ex
+++ b/lib/mix/lib/mix.ex
@@ -644,10 +644,11 @@ defmodule Mix do
       names with respective values as binaries. The system environment is made part
       of the `Mix.install/2` cache, so different configurations will lead to different apps
 
-    * `:config` (since v1.13.0) - a keyword list of keyword lists with application
-      configuration to be set before the apps loaded. The configuration is part of
-      the `Mix.install/2` cache, so different configurations will lead to different
-      apps
+    * `:config` (since v1.13.0) - a keyword list of keyword lists of compile-time
+      configuration. The configuration is part of the `Mix.install/2` cache, so
+      different configurations will lead to different apps. For this reason, you
+      want to minimize the amount of configuration set through this option.
+      Use `Application.put_all_env/4` for setting other runtime configuration.
 
     * `:config_path` (since v1.14.0) - path to a configuration file. If a `runtime.exs`
       file exists in the same directory as the given path, it is loaded too.