diff options
Diffstat (limited to 'docs/en/erlang.mk/1/guide/getting_started/index.html')
| -rw-r--r-- | docs/en/erlang.mk/1/guide/getting_started/index.html | 422 |
1 files changed, 159 insertions, 263 deletions
diff --git a/docs/en/erlang.mk/1/guide/getting_started/index.html b/docs/en/erlang.mk/1/guide/getting_started/index.html index 70ea7527..e6f3b05f 100644 --- a/docs/en/erlang.mk/1/guide/getting_started/index.html +++ b/docs/en/erlang.mk/1/guide/getting_started/index.html @@ -62,362 +62,258 @@ <h1 class="lined-header"><span>Getting started</span></h1> -<div class="paragraph"><p>This chapter explains how to get started using Erlang.mk.</p></div> -<div class="sect1"> +<p>This chapter explains how to get started using Erlang.mk.</p> <h2 id="_creating_a_folder_for_your_project">Creating a folder for your project</h2> -<div class="sectionbody"> -<div class="paragraph"><p>The first step is always to create a new folder that will -contain your project.</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>The first step is always to create a new folder that will contain your project.</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ mkdir hello_joe -$ cd hello_joe</tt></pre></div></div> -<div class="paragraph"><p>Most people tend to put all their projects side by side in -a common folder. We recommend keeping an organization similar -to your remote repositories. For example, for GitHub users, -put all your projects in a common folder with the same name -as your username. For example <em>$HOME/ninenines/cowboy</em> for -the Cowboy project.</p></div> -</div> -</div> -<div class="sect1"> +$ cd hello_joe</tt></pre> +</div></div> +<p>Most people tend to put all their projects side by side in a common folder. We recommend keeping an organization similar to your remote repositories. For example, for GitHub users, put all your projects in a common folder with the same name as your username. For example <em>$HOME/ninenines/cowboy</em> for the Cowboy project.</p> <h2 id="_downloading_erlang_mk">Downloading Erlang.mk</h2> -<div class="sectionbody"> -<div class="paragraph"><p>At the time of writing, Erlang.mk is unlikely to be present -in your Erlang distribution, or even in your OS packages.</p></div> -<div class="paragraph"><p>The next step is therefore to download it:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>At the time of writing, Erlang.mk is unlikely to be present in your Erlang distribution, or even in your OS packages.</p> +<p>The next step is therefore to download it:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ wget https<span style="color: #990000">:</span>//erlang<span style="color: #990000">.</span>mk/erlang<span style="color: #990000">.</span>mk</tt></pre></div></div> -<div class="paragraph"><p>Or:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ wget https<font color="#990000">:</font>//erlang<font color="#990000">.</font>mk/erlang<font color="#990000">.</font>mk</tt></pre> +</div></div> +<p>Or:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ curl -O https<span style="color: #990000">:</span>//erlang<span style="color: #990000">.</span>mk/erlang<span style="color: #990000">.</span>mk</tt></pre></div></div> -<div class="paragraph"><p>Alternatively, just <a href="https://erlang.mk/erlang.mk">click on this link</a>.</p></div> -<div class="paragraph"><p>Make sure you put the file inside the folder we created previously.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>$ curl -O https<font color="#990000">:</font>//erlang<font color="#990000">.</font>mk/erlang<font color="#990000">.</font>mk</tt></pre> +</div></div> +<p>Alternatively, just <a href="https://erlang.mk/erlang.mk">click on this link</a>.</p> +<p>Make sure you put the file inside the folder we created previously.</p> <h2 id="_getting_started_with_otp_applications">Getting started with OTP applications</h2> -<div class="sectionbody"> -<div class="paragraph"><p>An OTP application is an Erlang application that has a supervision -tree. In other words, it will always have processes running.</p></div> -<div class="paragraph"><p>This kind of project can be automatically generated by Erlang.mk. -All you need to do is use the <code>bootstrap</code> target:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>An OTP application is an Erlang application that has a supervision tree. In other words, it will always have processes running.</p> +<p>This kind of project can be automatically generated by Erlang.mk. All you need to do is use the <code>bootstrap</code> target:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make -f erlang<span style="color: #990000">.</span>mk bootstrap</tt></pre></div></div> -<div class="paragraph"><p>Something similar to the following snippet will then appear -on your screen:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make -f erlang<font color="#990000">.</font>mk bootstrap</tt></pre> +</div></div> +<p>Something similar to the following snippet will then appear on your screen:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>git clone https<span style="color: #990000">:</span>//github<span style="color: #990000">.</span>com/ninenines/erlang<span style="color: #990000">.</span>mk <span style="color: #990000">.</span>erlang<span style="color: #990000">.</span>mk<span style="color: #990000">.</span>build -Cloning into <span style="color: #FF0000">'.erlang.mk.build'</span><span style="color: #990000">...</span> -remote<span style="color: #990000">:</span> Counting objects<span style="color: #990000">:</span> <span style="color: #993399">4035</span><span style="color: #990000">,</span> <span style="font-weight: bold"><span style="color: #0000FF">done</span></span><span style="color: #990000">.</span> -remote<span style="color: #990000">:</span> Compressing objects<span style="color: #990000">:</span> <span style="color: #993399">100</span><span style="color: #990000">%</span> <span style="color: #990000">(</span><span style="color: #993399">12</span><span style="color: #990000">/</span><span style="color: #993399">12</span><span style="color: #990000">),</span> <span style="font-weight: bold"><span style="color: #0000FF">done</span></span><span style="color: #990000">.</span> -remote<span style="color: #990000">:</span> Total <span style="color: #993399">4035</span> <span style="color: #990000">(</span>delta <span style="color: #993399">8</span><span style="color: #990000">),</span> reused <span style="color: #993399">4</span> <span style="color: #990000">(</span>delta <span style="color: #993399">4</span><span style="color: #990000">),</span> pack-reused <span style="color: #993399">4019</span> -Receiving objects<span style="color: #990000">:</span> <span style="color: #993399">100</span><span style="color: #990000">%</span> <span style="color: #990000">(</span><span style="color: #993399">4035</span><span style="color: #990000">/</span><span style="color: #993399">4035</span><span style="color: #990000">),</span> <span style="color: #993399">1.10</span> MiB <span style="color: #990000">|</span> <span style="color: #993399">784.00</span> KiB/s<span style="color: #990000">,</span> <span style="font-weight: bold"><span style="color: #0000FF">done</span></span><span style="color: #990000">.</span> -Resolving deltas<span style="color: #990000">:</span> <span style="color: #993399">100</span><span style="color: #990000">%</span> <span style="color: #990000">(</span><span style="color: #993399">2442</span><span style="color: #990000">/</span><span style="color: #993399">2442</span><span style="color: #990000">),</span> <span style="font-weight: bold"><span style="color: #0000FF">done</span></span><span style="color: #990000">.</span> -Checking connectivity<span style="color: #990000">...</span> <span style="font-weight: bold"><span style="color: #0000FF">done</span></span><span style="color: #990000">.</span> -<span style="font-weight: bold"><span style="color: #0000FF">if</span></span> <span style="color: #990000">[</span> -f build<span style="color: #990000">.</span>config <span style="color: #990000">];</span> <span style="font-weight: bold"><span style="color: #0000FF">then</span></span> cp build<span style="color: #990000">.</span>config <span style="color: #990000">.</span>erlang<span style="color: #990000">.</span>mk<span style="color: #990000">.</span>build<span style="color: #990000">;</span> <span style="font-weight: bold"><span style="color: #0000FF">fi</span></span> -cd <span style="color: #990000">.</span>erlang<span style="color: #990000">.</span>mk<span style="color: #990000">.</span>build <span style="color: #990000">&&</span> make -make<span style="color: #990000">[</span><span style="color: #993399">1</span><span style="color: #990000">]:</span> Entering directory <span style="color: #FF0000">'/home/essen/tmp/hello_joe/.erlang.mk.build'</span> -awk <span style="color: #FF0000">'FNR==1 && NR!=1{print ""}1'</span> core/core<span style="color: #990000">.</span>mk index<span style="color: #990000">/*.</span>mk core/index<span style="color: #990000">.</span>mk core/deps<span style="color: #990000">.</span>mk plugins/protobuffs<span style="color: #990000">.</span>mk core/erlc<span style="color: #990000">.</span>mk core/docs<span style="color: #990000">.</span>mk core/test<span style="color: #990000">.</span>mk plugins/asciidoc<span style="color: #990000">.</span>mk plugins/bootstrap<span style="color: #990000">.</span>mk plugins/c_src<span style="color: #990000">.</span>mk plugins/ci<span style="color: #990000">.</span>mk plugins/ct<span style="color: #990000">.</span>mk plugins/dialyzer<span style="color: #990000">.</span>mk plugins/edoc<span style="color: #990000">.</span>mk plugins/elvis<span style="color: #990000">.</span>mk plugins/erlydtl<span style="color: #990000">.</span>mk plugins/escript<span style="color: #990000">.</span>mk plugins/eunit<span style="color: #990000">.</span>mk plugins/relx<span style="color: #990000">.</span>mk plugins/shell<span style="color: #990000">.</span>mk plugins/triq<span style="color: #990000">.</span>mk plugins/xref<span style="color: #990000">.</span>mk plugins/cover<span style="color: #990000">.</span>mk <span style="color: #990000">\</span> - <span style="color: #990000">|</span> sed <span style="color: #FF0000">'s/^ERLANG_MK_VERSION = .*/ERLANG_MK_VERSION = 1.2.0-642-gccd2b9f/'</span> <span style="color: #990000">></span> erlang<span style="color: #990000">.</span>mk -make<span style="color: #990000">[</span><span style="color: #993399">1</span><span style="color: #990000">]:</span> Leaving directory <span style="color: #FF0000">'/home/essen/tmp/hello_joe/.erlang.mk.build'</span> -cp <span style="color: #990000">.</span>erlang<span style="color: #990000">.</span>mk<span style="color: #990000">.</span>build/erlang<span style="color: #990000">.</span>mk <span style="color: #990000">.</span>/erlang<span style="color: #990000">.</span>mk -rm -rf <span style="color: #990000">.</span>erlang<span style="color: #990000">.</span>mk<span style="color: #990000">.</span>build</tt></pre></div></div> -<div class="paragraph"><p>This is Erlang.mk bootstrapping itself. Indeed, the file you -initially downloaded contains nothing more than the code needed -to bootstrap. This operation is done only once. Consult the -<a href="../updating">Updating Erlang.mk</a> chapter for more -information.</p></div> -<div class="paragraph"><p>Of course, the generated project can now be compiled:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>git clone https<font color="#990000">:</font>//github<font color="#990000">.</font>com/ninenines/erlang<font color="#990000">.</font>mk <font color="#990000">.</font>erlang<font color="#990000">.</font>mk<font color="#990000">.</font>build +Cloning into <font color="#FF0000">'.erlang.mk.build'</font><font color="#990000">...</font> +remote<font color="#990000">:</font> Counting objects<font color="#990000">:</font> <font color="#993399">4035</font><font color="#990000">,</font> <b><font color="#0000FF">done</font></b><font color="#990000">.</font> +remote<font color="#990000">:</font> Compressing objects<font color="#990000">:</font> <font color="#993399">100</font><font color="#990000">%</font> <font color="#990000">(</font><font color="#993399">12</font><font color="#990000">/</font><font color="#993399">12</font><font color="#990000">),</font> <b><font color="#0000FF">done</font></b><font color="#990000">.</font> +remote<font color="#990000">:</font> Total <font color="#993399">4035</font> <font color="#990000">(</font>delta <font color="#993399">8</font><font color="#990000">),</font> reused <font color="#993399">4</font> <font color="#990000">(</font>delta <font color="#993399">4</font><font color="#990000">),</font> pack-reused <font color="#993399">4019</font> +Receiving objects<font color="#990000">:</font> <font color="#993399">100</font><font color="#990000">%</font> <font color="#990000">(</font><font color="#993399">4035</font><font color="#990000">/</font><font color="#993399">4035</font><font color="#990000">),</font> <font color="#993399">1.10</font> MiB <font color="#990000">|</font> <font color="#993399">784.00</font> KiB/s<font color="#990000">,</font> <b><font color="#0000FF">done</font></b><font color="#990000">.</font> +Resolving deltas<font color="#990000">:</font> <font color="#993399">100</font><font color="#990000">%</font> <font color="#990000">(</font><font color="#993399">2442</font><font color="#990000">/</font><font color="#993399">2442</font><font color="#990000">),</font> <b><font color="#0000FF">done</font></b><font color="#990000">.</font> +Checking connectivity<font color="#990000">...</font> <b><font color="#0000FF">done</font></b><font color="#990000">.</font> +<b><font color="#0000FF">if</font></b> <font color="#990000">[</font> -f build<font color="#990000">.</font>config <font color="#990000">];</font> <b><font color="#0000FF">then</font></b> cp build<font color="#990000">.</font>config <font color="#990000">.</font>erlang<font color="#990000">.</font>mk<font color="#990000">.</font>build<font color="#990000">;</font> <b><font color="#0000FF">fi</font></b> +cd <font color="#990000">.</font>erlang<font color="#990000">.</font>mk<font color="#990000">.</font>build <font color="#990000">&&</font> make +make<font color="#990000">[</font><font color="#993399">1</font><font color="#990000">]:</font> Entering directory <font color="#FF0000">'/home/essen/tmp/hello_joe/.erlang.mk.build'</font> +awk <font color="#FF0000">'FNR==1 && NR!=1{print ""}1'</font> core/core<font color="#990000">.</font>mk index<font color="#990000">/*.</font>mk core/index<font color="#990000">.</font>mk core/deps<font color="#990000">.</font>mk plugins/protobuffs<font color="#990000">.</font>mk core/erlc<font color="#990000">.</font>mk core/docs<font color="#990000">.</font>mk core/test<font color="#990000">.</font>mk plugins/asciidoc<font color="#990000">.</font>mk plugins/bootstrap<font color="#990000">.</font>mk plugins/c_src<font color="#990000">.</font>mk plugins/ci<font color="#990000">.</font>mk plugins/ct<font color="#990000">.</font>mk plugins/dialyzer<font color="#990000">.</font>mk plugins/edoc<font color="#990000">.</font>mk plugins/elvis<font color="#990000">.</font>mk plugins/erlydtl<font color="#990000">.</font>mk plugins/escript<font color="#990000">.</font>mk plugins/eunit<font color="#990000">.</font>mk plugins/relx<font color="#990000">.</font>mk plugins/shell<font color="#990000">.</font>mk plugins/triq<font color="#990000">.</font>mk plugins/xref<font color="#990000">.</font>mk plugins/cover<font color="#990000">.</font>mk <font color="#990000">\</font> + <font color="#990000">|</font> sed <font color="#FF0000">'s/^ERLANG_MK_VERSION = .*/ERLANG_MK_VERSION = 1.2.0-642-gccd2b9f/'</font> <font color="#990000">></font> erlang<font color="#990000">.</font>mk +make<font color="#990000">[</font><font color="#993399">1</font><font color="#990000">]:</font> Leaving directory <font color="#FF0000">'/home/essen/tmp/hello_joe/.erlang.mk.build'</font> +cp <font color="#990000">.</font>erlang<font color="#990000">.</font>mk<font color="#990000">.</font>build/erlang<font color="#990000">.</font>mk <font color="#990000">.</font>/erlang<font color="#990000">.</font>mk +rm -rf <font color="#990000">.</font>erlang<font color="#990000">.</font>mk<font color="#990000">.</font>build</tt></pre> +</div></div> +<p>This is Erlang.mk bootstrapping itself. Indeed, the file you initially downloaded contains nothing more than the code needed to bootstrap. This operation is done only once. Consult the <a href="../updating">Updating Erlang.mk</a> chapter for more information.</p> +<p>Of course, the generated project can now be compiled:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make</tt></pre></div></div> -<div class="paragraph"><p>Cheers!</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>$ make</tt></pre> +</div></div> +<p>Cheers!</p> <h2 id="_getting_started_with_otp_libraries">Getting started with OTP libraries</h2> -<div class="sectionbody"> -<div class="paragraph"><p>An OTP library is an Erlang application that has no supervision -tree. In other words, it is nothing but modules.</p></div> -<div class="paragraph"><p>This kind of project can also be generated by Erlang.mk, using -the <code>bootstrap-lib</code> target:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>An OTP library is an Erlang application that has no supervision tree. In other words, it is nothing but modules.</p> +<p>This kind of project can also be generated by Erlang.mk, using the <code>bootstrap-lib</code> target:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make -f erlang<span style="color: #990000">.</span>mk bootstrap-lib</tt></pre></div></div> -<div class="paragraph"><p>Erlang.mk will once again bootstrap itself and generate all -the files for your project. You can now compile it:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make -f erlang<font color="#990000">.</font>mk bootstrap-lib</tt></pre> +</div></div> +<p>Erlang.mk will once again bootstrap itself and generate all the files for your project. You can now compile it:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make</tt></pre></div></div> -<div class="paragraph"><p>Enjoy!</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>$ make</tt></pre> +</div></div> +<p>Enjoy!</p> <h2 id="_getting_started_with_otp_releases">Getting started with OTP releases</h2> -<div class="sectionbody"> -<div class="paragraph"><p>An OTP release is the combination of the Erlang RunTime System (ERTS) -along with all the libraries and files that your node will need -to run. It is entirely self contained, and can often be sent as-is -to your production system and run without any extra setup.</p></div> -<div class="paragraph"><p>Erlang.mk can of course bootstrap your project to generate releases. -You can use the <code>bootstrap-rel</code> target for this purpose:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>An OTP release is the combination of the Erlang RunTime System (ERTS) along with all the libraries and files that your node will need to run. It is entirely self contained, and can often be sent as-is to your production system and run without any extra setup.</p> +<p>Erlang.mk can of course bootstrap your project to generate releases. You can use the <code>bootstrap-rel</code> target for this purpose:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make bootstrap-rel</tt></pre></div></div> -<div class="paragraph"><p>This target can be combined with <code>bootstrap</code> or <code>bootstrap-lib</code> to -create a project that will build a release:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make bootstrap-rel</tt></pre> +</div></div> +<p>This target can be combined with <code>bootstrap</code> or <code>bootstrap-lib</code> to create a project that will build a release:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make -f erlang<span style="color: #990000">.</span>mk bootstrap-lib bootstrap-rel</tt></pre></div></div> -<div class="paragraph"><p>It is often very useful to keep the top-level project for -commands useful during operations, and put the components -of the system in separate applications that you will then -depend on. Consult the <a href="../deps">Packages and dependencies</a> -chapter for more information.</p></div> -<div class="paragraph"><p>When you run <code>make</code> from now on, Erlang.mk will compile your -project and build the release:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make -f erlang<font color="#990000">.</font>mk bootstrap-lib bootstrap-rel</tt></pre> +</div></div> +<p>It is often very useful to keep the top-level project for commands useful during operations, and put the components of the system in separate applications that you will then depend on. Consult the <a href="../deps">Packages and dependencies</a> chapter for more information.</p> +<p>When you run <code>make</code> from now on, Erlang.mk will compile your project and build the release:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make - APP hello_joe<span style="color: #990000">.</span>app<span style="color: #990000">.</span>src + APP hello_joe<font color="#990000">.</font>app<font color="#990000">.</font>src GEN distclean-relx-rel GEN /home/essen/tmp/hello_joe/relx -<span style="color: #990000">===></span> Starting relx build process <span style="color: #990000">...</span> -<span style="color: #990000">===></span> Resolving OTP Applications from directories<span style="color: #990000">:</span> +<font color="#990000">===></font> Starting relx build process <font color="#990000">...</font> +<font color="#990000">===></font> Resolving OTP Applications from directories<font color="#990000">:</font> /home/essen/tmp/hello_joe/ebin /usr/lib/erlang/lib /home/essen/tmp/hello_joe/deps -<span style="color: #990000">===></span> Resolved hello_joe_release-<span style="color: #993399">1</span> -<span style="color: #990000">===></span> Including Erts from /usr/lib/erlang -<span style="color: #990000">===></span> release successfully created<span style="color: #990000">!</span></tt></pre></div></div> -<div class="paragraph"><p>The first time you run this command, Erlang.mk will download -<em>relx</em>, the release building tool. So don’t worry if you see -more output than above.</p></div> -<div class="paragraph"><p>If building the release is slow, no need to upgrade your -hardware just yet. Just consult the <a href="../relx">Releases</a> -chapter for various tips to speed up build time during -development.</p></div> -<div class="paragraph"><p>You can start the release using the <em>./_rel/hello_joe_release/bin/hello_joe_release</em> -script, or simply run <code>make run</code>. The latter will also compile -your project and build the release if it wasn’t already:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<font color="#990000">===></font> Resolved hello_joe_release-<font color="#993399">1</font> +<font color="#990000">===></font> Including Erts from /usr/lib/erlang +<font color="#990000">===></font> release successfully created<font color="#990000">!</font></tt></pre> +</div></div> +<p>The first time you run this command, Erlang.mk will download <em>relx</em>, the release building tool. So don't worry if you see more output than above.</p> +<p>If building the release is slow, no need to upgrade your hardware just yet. Just consult the <a href="../relx">Releases</a> chapter for various tips to speed up build time during development.</p> +<p>You can start the release using the <em>./_rel/hello_joe_release/bin/hello_joe_release</em> script, or simply run <code>make run</code>. The latter will also compile your project and build the release if it wasn't already:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make run - APP hello_joe<span style="color: #990000">.</span>app<span style="color: #990000">.</span>src + APP hello_joe<font color="#990000">.</font>app<font color="#990000">.</font>src GEN distclean-relx-rel -<span style="color: #990000">===></span> Starting relx build process <span style="color: #990000">...</span> -<span style="color: #990000">===></span> Resolving OTP Applications from directories<span style="color: #990000">:</span> +<font color="#990000">===></font> Starting relx build process <font color="#990000">...</font> +<font color="#990000">===></font> Resolving OTP Applications from directories<font color="#990000">:</font> /home/essen/tmp/hello_joe/ebin /usr/lib/erlang/lib /home/essen/tmp/hello_joe/deps -<span style="color: #990000">===></span> Resolved hello_joe_release-<span style="color: #993399">1</span> -<span style="color: #990000">===></span> Including Erts from /usr/lib/erlang -<span style="color: #990000">===></span> release successfully created<span style="color: #990000">!</span> -Exec<span style="color: #990000">:</span> /home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release/erts-<span style="color: #993399">7.0</span>/bin/erlexec -boot /home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release/releases<span style="color: #990000">/</span><span style="color: #993399">1</span>/hello_joe_release -boot_var ERTS_LIB_DIR /home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release/erts-<span style="color: #993399">7.0</span><span style="color: #990000">/..</span>/lib -env ERL_LIBS /home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release/releases<span style="color: #990000">/</span><span style="color: #993399">1</span>/lib -config /home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release/releases<span style="color: #990000">/</span><span style="color: #993399">1</span>/sys<span style="color: #990000">.</span>config -args_file /home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release/releases<span style="color: #990000">/</span><span style="color: #993399">1</span>/vm<span style="color: #990000">.</span>args -- console -Root<span style="color: #990000">:</span> /home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release -/home/essen/tmp/hello_joe<span style="color: #990000">/</span>_rel/hello_joe_release -heart_beat_kill_pid <span style="color: #990000">=</span> <span style="color: #993399">16389</span> -Erlang/OTP <span style="color: #993399">18</span> <span style="color: #990000">[</span>erts-<span style="color: #993399">7.0</span><span style="color: #990000">]</span> <span style="color: #990000">[</span><span style="font-weight: bold"><span style="color: #0000FF">source</span></span><span style="color: #990000">]</span> <span style="color: #990000">[</span><span style="color: #993399">64</span>-bit<span style="color: #990000">]</span> <span style="color: #990000">[</span>smp<span style="color: #990000">:</span><span style="color: #993399">4</span><span style="color: #990000">:</span><span style="color: #993399">4</span><span style="color: #990000">]</span> <span style="color: #990000">[</span>async-threads<span style="color: #990000">:</span><span style="color: #993399">10</span><span style="color: #990000">]</span> <span style="color: #990000">[</span>hipe<span style="color: #990000">]</span> <span style="color: #990000">[</span>kernel-poll<span style="color: #990000">:</span><span style="font-weight: bold"><span style="color: #0000FF">false</span></span><span style="color: #990000">]</span> - -Eshell V7<span style="color: #990000">.</span><span style="color: #993399">0</span> <span style="color: #990000">(</span>abort with <span style="color: #990000">^</span>G<span style="color: #990000">)</span> -<span style="color: #990000">(</span>hello_joe@<span style="color: #993399">127.0</span><span style="color: #990000">.</span><span style="color: #993399">0.1</span><span style="color: #990000">)</span><span style="color: #993399">1</span><span style="color: #990000">></span></tt></pre></div></div> -<div class="paragraph"><p>Simple as that!</p></div> -</div> -</div> -<div class="sect1"> +<font color="#990000">===></font> Resolved hello_joe_release-<font color="#993399">1</font> +<font color="#990000">===></font> Including Erts from /usr/lib/erlang +<font color="#990000">===></font> release successfully created<font color="#990000">!</font> +Exec<font color="#990000">:</font> /home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release/erts-<font color="#993399">7.0</font>/bin/erlexec -boot /home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release/releases<font color="#990000">/</font><font color="#993399">1</font>/hello_joe_release -boot_var ERTS_LIB_DIR /home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release/erts-<font color="#993399">7.0</font><font color="#990000">/..</font>/lib -env ERL_LIBS /home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release/releases<font color="#990000">/</font><font color="#993399">1</font>/lib -config /home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release/releases<font color="#990000">/</font><font color="#993399">1</font>/sys<font color="#990000">.</font>config -args_file /home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release/releases<font color="#990000">/</font><font color="#993399">1</font>/vm<font color="#990000">.</font>args -- console +Root<font color="#990000">:</font> /home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release +/home/essen/tmp/hello_joe<font color="#990000">/</font>_rel/hello_joe_release +heart_beat_kill_pid <font color="#990000">=</font> <font color="#993399">16389</font> +Erlang/OTP <font color="#993399">18</font> <font color="#990000">[</font>erts-<font color="#993399">7.0</font><font color="#990000">]</font> <font color="#990000">[</font><b><font color="#0000FF">source</font></b><font color="#990000">]</font> <font color="#990000">[</font><font color="#993399">64</font>-bit<font color="#990000">]</font> <font color="#990000">[</font>smp<font color="#990000">:</font><font color="#993399">4</font><font color="#990000">:</font><font color="#993399">4</font><font color="#990000">]</font> <font color="#990000">[</font>async-threads<font color="#990000">:</font><font color="#993399">10</font><font color="#990000">]</font> <font color="#990000">[</font>hipe<font color="#990000">]</font> <font color="#990000">[</font>kernel-poll<font color="#990000">:</font><b><font color="#0000FF">false</font></b><font color="#990000">]</font> + +Eshell V7<font color="#990000">.</font><font color="#993399">0</font> <font color="#990000">(</font>abort with <font color="#990000">^</font>G<font color="#990000">)</font> +<font color="#990000">(</font>hello_joe@<font color="#993399">127.0</font><font color="#990000">.</font><font color="#993399">0.1</font><font color="#990000">)</font><font color="#993399">1</font><font color="#990000">></font> </tt></pre> +</div></div> +<p>Simple as that!</p> <h2 id="_getting_started_from_scratch">Getting started from scratch</h2> -<div class="sectionbody"> -<div class="paragraph"><p>If you already have an application, or you want to have full -control over what files will be created, you can setup Erlang.mk -manually.</p></div> -<div class="paragraph"><p>Erlang.mk is very easy to setup: all that you need to do is to -create a folder, put Erlang.mk in it, and write a one line -Makefile containing:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>If you already have an application, or you want to have full control over what files will be created, you can setup Erlang.mk manually.</p> +<p>Erlang.mk is very easy to setup: all that you need to do is to create a folder, put Erlang.mk in it, and write a one line Makefile containing:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>include erlang.mk</tt></pre></div></div> -<div class="paragraph"><p>For a step by step:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>include erlang.mk</tt></pre> +</div></div> +<p>For a step by step:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ mkdir hello_joe $ cd hello_joe -$ curl https<span style="color: #990000">:</span>//erlang<span style="color: #990000">.</span>mk/erlang<span style="color: #990000">.</span>mk -o erlang<span style="color: #990000">.</span>mk -$ echo <span style="color: #FF0000">"include erlang.mk"</span> <span style="color: #990000">></span> Makefile -$ make</tt></pre></div></div> -<div class="paragraph"><p>From that point onward you can create an <code>src/</code> folder or start -using templates.</p></div> -</div> -</div> -<div class="sect1"> +$ curl https<font color="#990000">:</font>//erlang<font color="#990000">.</font>mk/erlang<font color="#990000">.</font>mk -o erlang<font color="#990000">.</font>mk +$ echo <font color="#FF0000">"include erlang.mk"</font> <font color="#990000">></font> Makefile +$ make</tt></pre> +</div></div> +<p>From that point onward you can create an <code>src/</code> folder or start using templates.</p> <h2 id="_using_spaces_instead_of_tabs">Using spaces instead of tabs</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Erlang.mk defaults to tabs when creating files from templates. -This is in part because of a personal preference, and in part -because it is much easier to convert tabs to spaces than the -opposite.</p></div> -<div class="paragraph"><p>Use the <code>SP</code> variable if you prefer spaces. Set it to the number -of spaces per indentation level you want.</p></div> -<div class="paragraph"><p>For example, if you prefer two spaces per indentation level:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>Erlang.mk defaults to tabs when creating files from templates. This is in part because of a personal preference, and in part because it is much easier to convert tabs to spaces than the opposite.</p> +<p>Use the <code>SP</code> variable if you prefer spaces. Set it to the number of spaces per indentation level you want.</p> +<p>For example, if you prefer two spaces per indentation level:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make -f erlang<span style="color: #990000">.</span>mk bootstrap <span style="color: #009900">SP</span><span style="color: #990000">=</span><span style="color: #993399">2</span></tt></pre></div></div> -<div class="paragraph"><p>When you bootstrap the project initially, the variable automatically -gets added to the Makefile, so you only need to provide it when -you get started.</p></div> -</div> -</div> -<div class="sect1"> +<pre><tt>$ make -f erlang<font color="#990000">.</font>mk bootstrap <font color="#009900">SP</font><font color="#990000">=</font><font color="#993399">2</font></tt></pre> +</div></div> +<p>When you bootstrap the project initially, the variable automatically gets added to the Makefile, so you only need to provide it when you get started.</p> <h2 id="_using_templates">Using templates</h2> -<div class="sectionbody"> -<div class="paragraph"><p>It is no secret that Erlang’s OTP behaviors tend to have some -boilerplate. It is rarely an issue of course, except when -creating new modules. That’s why Erlang.mk not only comes with -templates for generating projects, but also individual modules!</p></div> -<div class="paragraph"><p>You can list all available templates with the <code>list-templates</code> -target:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>It is no secret that Erlang's OTP behaviors tend to have some boilerplate. It is rarely an issue of course, except when creating new modules. That's why Erlang.mk not only comes with templates for generating projects, but also individual modules!</p> +<p>You can list all available templates with the <code>list-templates</code> target:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make list-templates -Available templates<span style="color: #990000">:</span> cowboy_http cowboy_loop cowboy_rest cowboy_ws gen_fsm gen_server gen_statem ranch_protocol supervisor</tt></pre></div></div> -<div class="paragraph"><p>To generate a module, let’s say a <code>gen_server</code>, all you need to -do is to call <code>make new</code> with the appropriate arguments:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +Available templates<font color="#990000">:</font> cowboy_http cowboy_loop cowboy_rest cowboy_ws gen_fsm gen_server gen_statem ranch_protocol supervisor</tt></pre> +</div></div> +<p>To generate a module, let's say a <code>gen_server</code>, all you need to do is to call <code>make new</code> with the appropriate arguments:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make new <span style="color: #009900">t</span><span style="color: #990000">=</span>gen_server <span style="color: #009900">n</span><span style="color: #990000">=</span>my_server</tt></pre></div></div> -<div class="paragraph"><p>This will create a module located in <em>src/my_server.erl</em> -using the <code>gen_server</code> template.</p></div> -<div class="paragraph"><p>This module is automatically compiled the next time you run -<code>make</code>:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make new <font color="#009900">t</font><font color="#990000">=</font>gen_server <font color="#009900">n</font><font color="#990000">=</font>my_server</tt></pre> +</div></div> +<p>This will create a module located in <em>src/my_server.erl</em> using the <code>gen_server</code> template.</p> +<p>This module is automatically compiled the next time you run <code>make</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> <pre><tt>$ make - ERLC my_server<span style="color: #990000">.</span>erl - APP hello_joe<span style="color: #990000">.</span>app<span style="color: #990000">.</span>src</tt></pre></div></div> -<div class="paragraph"><p>All that’s left to do is to open it in your favorite editor -and make it do something!</p></div> -</div> -</div> -<div class="sect1"> -<h2 id="_hiding_erlang_mk_from_git">Hiding Erlang.mk from git</h2> -<div class="sectionbody"> -<div class="paragraph"><p>Erlang.mk is a large text file. It can easily take a large part of -a <code>git diff</code> or a <code>git grep</code> command. You can avoid this by telling -Git that <em>erlang.mk</em> is a binary file.</p></div> -<div class="paragraph"><p>Add this to your <em>.gitattributes</em> file. This is a file that you -can create at the root of your repository:</p></div> -<div class="listingblock"> -<div class="content"> -<pre><code>erlang.mk -diff</code></pre> + ERLC my_server<font color="#990000">.</font>erl + APP hello_joe<font color="#990000">.</font>app<font color="#990000">.</font>src</tt></pre> </div></div> -<div class="paragraph"><p>The <em>erlang.mk</em> file will still appear in diffs and greps, but -as a binary file, meaning its contents won’t be shown by default -anymore.</p></div> -</div> -</div> -<div class="sect1"> +<p>All that's left to do is to open it in your favorite editor and make it do something!</p> +<h2 id="_hiding_erlang_mk_from_git">Hiding Erlang.mk from git</h2> +<p>Erlang.mk is a large text file. It can easily take a large part of a <code>git diff</code> or a <code>git grep</code> command. You can avoid this by telling Git that <em>erlang.mk</em> is a binary file.</p> +<p>Add this to your <em>.gitattributes</em> file. This is a file that you can create at the root of your repository:</p> +<div class="listingblock"><div class="content"><pre>erlang.mk -diff</pre></div></div> +<p>The <em>erlang.mk</em> file will still appear in diffs and greps, but as a binary file, meaning its contents won't be shown by default anymore.</p> <h2 id="_getting_help">Getting help</h2> -<div class="sectionbody"> -<div class="paragraph"><p>During development, if you don’t remember the name of a target, -you can always run <code>make help</code>:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>During development, if you don't remember the name of a target, you can always run <code>make help</code>:</p> +<div class="listingblock"><div class="content"><!-- Generator: GNU source-highlight 3.1.8 by Lorenzo Bettini http://www.lorenzobettini.it http://www.gnu.org/software/src-highlite --> -<pre><tt>$ make <span style="font-weight: bold"><span style="color: #0000FF">help</span></span> -erlang<span style="color: #990000">.</span>mk <span style="color: #990000">(</span>version <span style="color: #993399">1.2</span><span style="color: #990000">.</span><span style="color: #993399">0</span>-<span style="color: #993399">642</span>-gccd2b9f<span style="color: #990000">)</span> is distributed under the terms of the ISC License<span style="color: #990000">.</span> -Copyright <span style="color: #990000">(</span>c<span style="color: #990000">)</span> <span style="color: #993399">2013</span>-<span style="color: #993399">2016</span> Loïc Hoguin <span style="color: #990000"><</span>essen@ninenines<span style="color: #990000">.</span>eu<span style="color: #990000">></span> +<pre><tt>$ make <b><font color="#0000FF">help</font></b> +erlang<font color="#990000">.</font>mk <font color="#990000">(</font>version <font color="#993399">1.2</font><font color="#990000">.</font><font color="#993399">0</font>-<font color="#993399">642</font>-gccd2b9f<font color="#990000">)</font> is distributed under the terms of the ISC License<font color="#990000">.</font> +Copyright <font color="#990000">(</font>c<font color="#990000">)</font> <font color="#993399">2013</font>-<font color="#993399">2016</font> Loïc Hoguin <font color="#990000"><</font>essen@ninenines<font color="#990000">.</font>eu<font color="#990000">></font> -Usage<span style="color: #990000">:</span> <span style="color: #990000">[</span><span style="color: #009900">V</span><span style="color: #990000">=</span><span style="color: #993399">1</span><span style="color: #990000">]</span> make <span style="color: #990000">[</span>target<span style="color: #990000">]...</span> +Usage<font color="#990000">:</font> <font color="#990000">[</font><font color="#009900">V</font><font color="#990000">=</font><font color="#993399">1</font><font color="#990000">]</font> make <font color="#990000">[</font>target<font color="#990000">]...</font> -Core targets<span style="color: #990000">:</span> - all Run deps<span style="color: #990000">,</span> app and rel targets <span style="font-weight: bold"><span style="color: #0000FF">in</span></span> that order +Core targets<font color="#990000">:</font> + all Run deps<font color="#990000">,</font> app and rel targets <b><font color="#0000FF">in</font></b> that order app Compile the project - deps Fetch dependencies <span style="color: #990000">(</span><span style="font-weight: bold"><span style="color: #0000FF">if</span></span> needed<span style="color: #990000">)</span> and compile them - search <span style="color: #009900">q</span><span style="color: #990000">=...</span> Search <span style="font-weight: bold"><span style="color: #0000FF">for</span></span> a package <span style="font-weight: bold"><span style="color: #0000FF">in</span></span> the built-in index - rel Build a release <span style="font-weight: bold"><span style="color: #0000FF">for</span></span> this project<span style="color: #990000">,</span> <span style="font-weight: bold"><span style="color: #0000FF">if</span></span> applicable - docs Build the documentation <span style="font-weight: bold"><span style="color: #0000FF">for</span></span> this project - install-docs Install the man pages <span style="font-weight: bold"><span style="color: #0000FF">for</span></span> this project - check Compile and run all tests and analysis <span style="font-weight: bold"><span style="color: #0000FF">for</span></span> this project - tests Run the tests <span style="font-weight: bold"><span style="color: #0000FF">for</span></span> this project + deps Fetch dependencies <font color="#990000">(</font><b><font color="#0000FF">if</font></b> needed<font color="#990000">)</font> and compile them + search <font color="#009900">q</font><font color="#990000">=...</font> Search <b><font color="#0000FF">for</font></b> a package <b><font color="#0000FF">in</font></b> the built-in index + rel Build a release <b><font color="#0000FF">for</font></b> this project<font color="#990000">,</font> <b><font color="#0000FF">if</font></b> applicable + docs Build the documentation <b><font color="#0000FF">for</font></b> this project + install-docs Install the man pages <b><font color="#0000FF">for</font></b> this project + check Compile and run all tests and analysis <b><font color="#0000FF">for</font></b> this project + tests Run the tests <b><font color="#0000FF">for</font></b> this project clean Delete temporary and output files from most targets distclean Delete all temporary and output files - <span style="font-weight: bold"><span style="color: #0000FF">help</span></span> Display this <span style="font-weight: bold"><span style="color: #0000FF">help</span></span> and <span style="font-weight: bold"><span style="color: #0000FF">exit</span></span> - erlang-mk Update erlang<span style="color: #990000">.</span>mk to the latest version + <b><font color="#0000FF">help</font></b> Display this <b><font color="#0000FF">help</font></b> and <b><font color="#0000FF">exit</font></b> + erlang-mk Update erlang<font color="#990000">.</font>mk to the latest version -Bootstrap targets<span style="color: #990000">:</span> +Bootstrap targets<font color="#990000">:</font> bootstrap Generate a skeleton of an OTP application bootstrap-lib Generate a skeleton of an OTP library bootstrap-rel Generate the files needed to build a release - new <span style="color: #009900">t</span><span style="color: #990000">=</span>TPL <span style="color: #009900">n</span><span style="color: #990000">=</span>NAME Generate a module NAME based on the template TPL + new <font color="#009900">t</font><font color="#990000">=</font>TPL <font color="#009900">n</font><font color="#990000">=</font>NAME Generate a module NAME based on the template TPL list-templates List available templates -<span style="color: #990000">...</span></tt></pre></div></div> -<div class="paragraph"><p>This guide should provide any other answer. If not, please -open a ticket on <a href="https://github.com/ninenines/erlang.mk/issues">the official repository</a> -and we will work on improving the guide.</p></div> -<div class="paragraph"><p>Commercial support is available through Nine Nines. Please contact -Loïc Hoguin by sending an email to <a href="mailto:[email protected]">[email protected]</a>.</p></div> -</div> -</div> +<font color="#990000">...</font></tt></pre> +</div></div> +<p>This guide should provide any other answer. If not, please open a ticket on <a href="https://github.com/ninenines/erlang.mk/issues">the official repository</a> and we will work on improving the guide.</p> +<p>Commercial support is available through Nine Nines. Please contact Loïc Hoguin by sending an email to <a href="mailto:[email protected]">[email protected]</a>.</p> + |