|
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Erlang.mk User Guide</title>
<style type="text/css"><!--
body{background:white;color:black;font-family:"Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;justify-content:center;margin:0 auto;padding:0;width:600px}
header {align-items:center;display:flex;justify-content:center}
header nav.left{text-align:right;width:150px}
header nav.right{text-align:left;width:150px}
header nav a{display:block;margin:1.5em 1em}
main{margin-top:2em;text-align:justify}
main h2, main h3{margin-top:2em}
a{color:#d9230f;text-decoration:none}
a:hover{text-decoration:underline}
a.xref{display:none}
h1, h2, h3{font-weight:normal}
div.navfooter{margin-bottom:1em}
--></style>
</head>
<body>
<header>
<nav class="left">
<a href="index.html">User guide</a>
<a href="getting_started.html">Tutorials</a>
</nav>
<a href="/" class="logo"><img src="../res/logo-small.png" alt="Erlang.mk" title="Erlang.mk: A build tool for Erlang that just works" height="200" width="206"/></a>
<nav class="right">
<a href="https://github.com/ninenines/erlang.mk/tree/master/index">470+ packages</a>
<a href="https://github.com/ninenines/erlang.mk/issues">Issues?</a>
</nav>
</header>
<main>
<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="getting_started.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="updating.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="overview"></a>Chapter 3. Overview</h1></div></div></div><p>Now that you know how to get started, let’s take a look at
what Erlang.mk can do for you.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_building_your_project"></a>3.1. Building your project</h2></div></div></div><p>Erlang.mk is first and foremost a build tool. It is especially
tailored for Erlang developers and follows widely accepted
practices in the Erlang community.</p><p>Erlang.mk will happily build all <a class="link" href="building.html" title="Chapter 6. Building">Erlang-specific files</a>
<a class="xref" href="building.html" title="Chapter 6. Building">Chapter 6, <em>Building</em></a>
you throw at it. Other kinds of files too, like C or C++ code
when you are working on <a class="link" href="ports.html" title="Chapter 8. NIFs and port drivers">a NIF or a port driver</a>
<a class="xref" href="ports.html" title="Chapter 8. NIFs and port drivers">Chapter 8, <em>NIFs and port drivers</em></a>.</p><p>Erlang.mk embraces the concept of <a class="link" href="deps.html" title="Chapter 7. Packages and dependencies">source dependencies</a>
<a class="xref" href="deps.html" title="Chapter 7. Packages and dependencies">Chapter 7, <em>Packages and dependencies</em></a>.
It can fetch dependency source code using a variety of mechanisms,
including fetching from Git, Mercurial or SVN.</p><p>Erlang.mk will automatically <a class="link" href="relx.html" title="Chapter 9. Releases">generate releases</a>
<a class="xref" href="relx.html" title="Chapter 9. Releases">Chapter 9, <em>Releases</em></a>
when applicable. It can also <a class="link" href="escript.html" title="Chapter 10. Escripts">generate escripts</a>
<a class="xref" href="escript.html" title="Chapter 10. Escripts">Chapter 10, <em>Escripts</em></a>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_exploring_the_package_index"></a>3.2. Exploring the package index</h2></div></div></div><p>Erlang.mk comes with a <a class="link" href="deps.html" title="Chapter 7. Packages and dependencies">built-in package index</a>
<a class="xref" href="deps.html" title="Chapter 7. Packages and dependencies">Chapter 7, <em>Packages and dependencies</em></a>.
It is built as an extension of the dependency system and is
meant to be used for discovery purposes.</p><p>No package is ever installed, they are only used as dependencies
and are always project-specific. They can be thought of as a
shortcut over plain dependencies.</p><p>You can get a list of all packages known to Erlang.mk by using
the <code class="literal">search</code> target:</p><pre class="programlisting">$ make search</pre><p>You can also use this target to search across all packages, for
example to find all packages related to Cowboy:</p><pre class="programlisting">$ make search q=cowboy</pre></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_generating_documentation"></a>3.3. Generating documentation</h2></div></div></div><p>Erlang.mk supports <span class="emphasis"><em>EDoc</em></span> and <span class="emphasis"><em>Asciidoc</em></span>.</p><p><a class="link" href="edoc.html" title="Chapter 13. EDoc comments">EDoc</a>
<a class="xref" href="edoc.html" title="Chapter 13. EDoc comments">Chapter 13, <em>EDoc comments</em></a> generates HTML documentation directly from
your source code.</p><p>While it is convenient, ask yourself: if all the documentation is
inside the source code, why not just open the source code directly?
That’s where <span class="emphasis"><em>Asciidoc</em></span> comes in.</p><p>The <a class="link" href="asciidoc.html" title="Chapter 12. Asciidoc documentation">Asciidoc</a>
<a class="xref" href="asciidoc.html" title="Chapter 12. Asciidoc documentation">Chapter 12, <em>Asciidoc documentation</em></a> plugin expects all documentation
to be separate from source. It will generate HTML, PDF, man pages and
more from the documentation you write in the <span class="emphasis"><em>doc/src/</em></span> folder in
your repository.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_running_tests"></a>3.4. Running tests</h2></div></div></div><p>Erlang.mk supports a lot of different testing and static
analysis tools.</p><p>The <a class="link" href="shell.html" title="Chapter 14. Erlang shell">make shell</a>
<a class="xref" href="shell.html" title="Chapter 14. Erlang shell">Chapter 14, <em>Erlang shell</em></a> command allows you
to test your project manually. You can automate these
unit tests with <a class="link" href="eunit.html" title="Chapter 15. EUnit">EUnit</a>
<a class="xref" href="eunit.html" title="Chapter 15. EUnit">Chapter 15, <em>EUnit</em></a> and test
your entire system with <a class="link" href="ct.html" title="Chapter 16. Common Test">Common Test</a>
<a class="xref" href="ct.html" title="Chapter 16. Common Test">Chapter 16, <em>Common Test</em></a>.
<a class="link" href="property_based_testing.html" title="Chapter 17. Property based testing">Property based testing</a>
<a class="xref" href="property_based_testing.html" title="Chapter 17. Property based testing">Chapter 17, <em>Property based testing</em></a>
with Triq is a strong alternative to writing unit tests
manually. <a class="link" href="coverage.html" title="Chapter 18. Code coverage">Code coverage</a>
<a class="xref" href="coverage.html" title="Chapter 18. Code coverage">Chapter 18, <em>Code coverage</em></a> can of course
be enabled during tests.</p><p>Erlang.mk comes with features to make your life easier when
setting up and using <a class="link" href="ci.html" title="Chapter 19. Continuous integration">Continuous integration</a>
<a class="xref" href="ci.html" title="Chapter 19. Continuous integration">Chapter 19, <em>Continuous integration</em></a>.</p><p>On the static analysis side of things, Erlang.mk comes with
support for <a class="link" href="dialyzer.html" title="Chapter 20. Dialyzer">Dialyzer</a>
<a class="xref" href="dialyzer.html" title="Chapter 20. Dialyzer">Chapter 20, <em>Dialyzer</em></a> and <a class="link" href="xref.html" title="Chapter 21. Xref">Xref</a>
<a class="xref" href="xref.html" title="Chapter 21. Xref">Chapter 21, <em>Xref</em></a>,
to perform success typing analysis and cross referencing
of the code.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_need_more"></a>3.5. Need more?</h2></div></div></div><p>Not convinced yet? You can read about <a class="link" href="why.html" title="Chapter 23. Why Erlang.mk">why you should use Erlang.mk</a>
<a class="xref" href="why.html" title="Chapter 23. Why Erlang.mk">Chapter 23, <em>Why Erlang.mk</em></a>
and its <a class="link" href="history.html" title="Chapter 24. Short history">history</a>
<a class="xref" href="history.html" title="Chapter 24. Short history">Chapter 24, <em>Short history</em></a>. And if you’re still not
convinced after that, it’s OK! The world would be boring if
everyone agreed on everything all the time.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="getting_started.html">Prev</a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="updating.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div>
</main>
</body>
</html>
|
