diff options
author | Gleb Peregud <gleber.p@gmail.com> | 2017-06-18 23:05:18 +0200 |
---|---|---|
committer | Gleb Peregud <gleber.p@gmail.com> | 2017-06-19 19:58:57 +0200 |
commit | 0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d (patch) | |
tree | f0a1cba3b61cc40b4c4da736f6aa445737c73e60 /pkgs/development/beam-modules/mix-bootstrap | |
parent | 7797e1a1dda661476dbb312b1f26896d32831ef5 (diff) | |
download | nixlib-0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d.tar nixlib-0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d.tar.gz nixlib-0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d.tar.bz2 nixlib-0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d.tar.lz nixlib-0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d.tar.xz nixlib-0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d.tar.zst nixlib-0fccd5bba40ce903ff25bb8f2ca09e86f3bef19d.zip |
erlang: update documentation.
The documentation got a bit stale compared to actual contents of nixpkgs. This commit focuses on updating existing docs, not on making sure all details of beam packages are covered.
Diffstat (limited to 'pkgs/development/beam-modules/mix-bootstrap')
-rwxr-xr-x | pkgs/development/beam-modules/mix-bootstrap | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/pkgs/development/beam-modules/mix-bootstrap b/pkgs/development/beam-modules/mix-bootstrap index c4a1b364daa7..6c9a20c6de2f 100755 --- a/pkgs/development/beam-modules/mix-bootstrap +++ b/pkgs/development/beam-modules/mix-bootstrap @@ -3,18 +3,16 @@ %%! -smp enable %%% --------------------------------------------------------------------------- %%% @doc -%%% The purpose of this command is to prepare a rebar3 project so that -%%% rebar3 understands that the dependencies are all already -%%% installed. If you want a hygienic build on nix then you must run -%%% this command before running rebar3. I suggest that you add a -%%% `Makefile` to your project and have the bootstrap command be a -%%% dependency of the build commands. See the nix documentation for +%%% The purpose of this command is to prepare a mix project so that mix +%%% understands that the dependencies are all already installed. If you want a +%%% hygienic build on nix then you must run this command before running mix. I +%%% suggest that you add a `Makefile` to your project and have the bootstrap +%%% command be a dependency of the build commands. See the nix documentation for %%% more information. %%% -%%% This command designed to have as few dependencies as possible so -%%% that it can be a dependency of root level packages like rebar3. To -%%% that end it does many things in a fairly simplistic way. That is -%%% by design. +%%% This command designed to have as few dependencies as possible so that it can +%%% be a dependency of root level packages like mix. To that end it does many +%%% things in a fairly simplistic way. That is by design. %%% %%% ### Assumptions %%% @@ -37,7 +35,7 @@ main(Args) -> %% @doc %% This takes an app name in the standard OTP <name>-<version> format -%% and returns just the app name. Why? because rebar is doesn't +%% and returns just the app name. Why? Because rebar doesn't %% respect OTP conventions in some cases. -spec fixup_app_name(file:name()) -> string(). fixup_app_name(Path) -> |