Skip to content

Commit 62a36ed

Browse files
author
José Valim
committed
Improve docs for each compiler, closes #4099
1 parent be0e983 commit 62a36ed

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ defmodule Mix.Tasks.Compile.Erlang do
4141
4242
For a list of the many more available options,
4343
see [`:compile.file/2`](http://www.erlang.org/doc/man/compile.html#file-2).
44+
45+
For example, to configure the `erlc_options` for your Erlang project you
46+
may run:
47+
48+
erlc_options: [:debug_info, {:i, 'path/to/include'}]
49+
4450
"""
4551

4652
@doc """

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

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ defmodule Mix.Tasks.Compile do
66
@moduledoc """
77
A meta task that compiles source files.
88
9-
It simply runs the compilers registered in your project. At
10-
the end of compilation it ensures load paths are set.
9+
It simply runs the compilers registered in your project.
1110
1211
## Configuration
1312
@@ -28,6 +27,18 @@ defmodule Mix.Tasks.Compile do
2827
this has undesirable side-effects (such as skipping some
2928
compiler checks) and should be avoided.
3029
30+
## Compilers
31+
32+
To see documentation for each specific compiler, you must
33+
invoke `help` directly for the compiler command:
34+
35+
mix help compile.elixir
36+
mix help compile.erlang
37+
38+
You can get a list of all compilers by running:
39+
40+
mix compile --list
41+
3142
## Command line options
3243
3344
* `--list` - list all enabled compilers

0 commit comments

Comments
 (0)