@@ -7,14 +7,24 @@ defmodule Mix.Tasks.Archive.Build do
77 Builds an archive according to the specification of the
88 [Erlang Archive Format](http://www.erlang.org/doc/man/code.html).
99
10+ Archives are meant to contain small projects, usually installed
11+ locally. Archives may be installed into a Mix environment by
12+ running `mix archive.install`. Once installed, the archive is
13+ available to all Mix projects. For this reason, the functionality
14+ behind archives is limited. For instance, archives do not include
15+ dependencies, as those would conflict with any dependency in a
16+ Mix project after the archive is installed. In general, we recommend
17+ the usage of archives to be limited for extensions of Mix, such
18+ as custom SCMs, package managers, etc. For general scripts to be
19+ installed into machines, please see `mix escript.build`.
20+
1021 The archive will be created in the current directory (which is
1122 expected to be the project root), unless an argument `-o` is
1223 provided with the file name.
1324
14- Archives are meant to contain small projects, usually installed
15- locally. By default, this command archives the current project
16- but the `-i` and `-o` options can be used to archive any directory.
17- For example, `mix archive.build` with no options translates to:
25+ By default, this command archives the current project but the `-i`
26+ option can be used to archive any directory. For example,
27+ `mix archive.build` with no options translates to:
1828
1929 mix archive.build -i _build/ENV/lib/APP -o APP-VERSION.ez
2030
0 commit comments