Skip to content

Commit a9559ef

Browse files
PragTobJosé Valim
authored andcommitted
Document that the :consolidate_protocols option is true by default (#5091)
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
1 parent cb43101 commit a9559ef

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

lib/mix/lib/mix/tasks/app.start.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ defmodule Mix.Tasks.App.Start do
2020
applications are started in permanent mode
2121
2222
* `:consolidate_protocols` - when `true`, loads consolidated
23-
protocols before start
23+
protocols before start. The default value is `true`.
2424
2525
* `:elixir` - matches the current elixir version against the
2626
given requirement

lib/mix/lib/mix/tasks/compile.ex

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ defmodule Mix.Tasks.Compile do
1414
`[:yecc, :leex, :erlang, :elixir, :xref, :app]`
1515
1616
* `:consolidate_protocols` - when `true`, runs protocol
17-
consolidation via the `compile.protocols` task
17+
consolidation via the `compile.protocols` task. The default
18+
value is `true`.
1819
1920
* `:build_embedded` - when `true`, activates protocol
2021
consolidation and does not generate symlinks in builds

lib/mix/lib/mix/tasks/compile.protocols.ex

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ defmodule Mix.Tasks.Compile.Protocols do
99
1010
This task is automatically invoked whenever the project
1111
enables `:consolidate_protocols` or `:build_embedded` in
12-
its configuration.
12+
its configuration. As `:consolidate_protocols` is enabled
13+
in the default configuration, this is the default case.
1314
1415
## Consolidation
1516

0 commit comments

Comments
 (0)