diff options
Diffstat (limited to 'guide/overview.html')
-rw-r--r-- | guide/overview.html | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/guide/overview.html b/guide/overview.html index a449133..4e5743f 100644 --- a/guide/overview.html +++ b/guide/overview.html @@ -53,35 +53,35 @@ meant to be used for discovery purposes.</p><p>No package is ever installed, the 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 14. EDoc comments">EDoc</a> -<a class="xref" href="edoc.html" title="Chapter 14. EDoc comments">Chapter 14, <em>EDoc comments</em></a> generates HTML documentation directly from +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 15. EDoc comments">EDoc</a> +<a class="xref" href="edoc.html" title="Chapter 15. EDoc comments">Chapter 15, <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 13. AsciiDoc documentation">Asciidoc</a> -<a class="xref" href="asciidoc.html" title="Chapter 13. AsciiDoc documentation">Chapter 13, <em>AsciiDoc documentation</em></a> plugin expects all documentation +That’s where <span class="emphasis"><em>Asciidoc</em></span> comes in.</p><p>The <a class="link" href="asciidoc.html" title="Chapter 14. AsciiDoc documentation">Asciidoc</a> +<a class="xref" href="asciidoc.html" title="Chapter 14. AsciiDoc documentation">Chapter 14, <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 15. Erlang shell">make shell</a> -<a class="xref" href="shell.html" title="Chapter 15. Erlang shell">Chapter 15, <em>Erlang shell</em></a> command allows you +analysis tools.</p><p>The <a class="link" href="shell.html" title="Chapter 16. Erlang shell">make shell</a> +<a class="xref" href="shell.html" title="Chapter 16. Erlang shell">Chapter 16, <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 16. EUnit">EUnit</a> -<a class="xref" href="eunit.html" title="Chapter 16. EUnit">Chapter 16, <em>EUnit</em></a> and test -your entire system with <a class="link" href="ct.html" title="Chapter 17. Common Test">Common Test</a> -<a class="xref" href="ct.html" title="Chapter 17. Common Test">Chapter 17, <em>Common Test</em></a>. -<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 +unit tests with <a class="link" href="eunit.html" title="Chapter 17. EUnit">EUnit</a> +<a class="xref" href="eunit.html" title="Chapter 17. EUnit">Chapter 17, <em>EUnit</em></a> and test +your entire system with <a class="link" href="ct.html" title="Chapter 18. Common Test">Common Test</a> +<a class="xref" href="ct.html" title="Chapter 18. Common Test">Chapter 18, <em>Common Test</em></a>. +<a class="link" href="coverage.html" title="Chapter 19. Code coverage">Code coverage</a> +<a class="xref" href="coverage.html" title="Chapter 19. Code coverage">Chapter 19, <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>, +setting up and using <a class="link" href="ci.html" title="Chapter 20. Continuous integration">Continuous integration</a> +<a class="xref" href="ci.html" title="Chapter 20. Continuous integration">Chapter 20, <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 21. Dialyzer">Dialyzer</a> +<a class="xref" href="dialyzer.html" title="Chapter 21. Dialyzer">Chapter 21, <em>Dialyzer</em></a> and <a class="link" href="xref.html" title="Chapter 22. Xref">Xref</a> +<a class="xref" href="xref.html" title="Chapter 22. Xref">Chapter 22, <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 24. Why Erlang.mk">why you should use Erlang.mk</a> -<a class="xref" href="why.html" title="Chapter 24. Why Erlang.mk">Chapter 24, <em>Why Erlang.mk</em></a> -and its <a class="link" href="history.html" title="Chapter 25. Short history">history</a> -<a class="xref" href="history.html" title="Chapter 25. Short history">Chapter 25, <em>Short history</em></a>. And if you’re still not +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 25. Why Erlang.mk">why you should use Erlang.mk</a> +<a class="xref" href="why.html" title="Chapter 25. Why Erlang.mk">Chapter 25, <em>Why Erlang.mk</em></a> +and its <a class="link" href="history.html" title="Chapter 26. Short history">history</a> +<a class="xref" href="history.html" title="Chapter 26. Short history">Chapter 26, <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> |