aboutsummaryrefslogtreecommitdiffstats
path: root/guide/dialyzer.html
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-12-07 14:47:08 +0100
committerLoïc Hoguin <[email protected]>2018-12-07 14:47:08 +0100
commit7bdfe79950d05b3bfd6b4ab5e652951db0cabf5c (patch)
tree638a78fe61926e9d3177905beb4c429732cc7e60 /guide/dialyzer.html
parent1a6311a3a4933e767ba057780cefe1600f50f5c3 (diff)
downloaderlang.mk-7bdfe79950d05b3bfd6b4ab5e652951db0cabf5c.tar.gz
erlang.mk-7bdfe79950d05b3bfd6b4ab5e652951db0cabf5c.tar.bz2
erlang.mk-7bdfe79950d05b3bfd6b4ab5e652951db0cabf5c.zip
Update user guide
Diffstat (limited to 'guide/dialyzer.html')
-rw-r--r--guide/dialyzer.html10
1 files changed, 5 insertions, 5 deletions
diff --git a/guide/dialyzer.html b/guide/dialyzer.html
index aa9dc66..471e876 100644
--- a/guide/dialyzer.html
+++ b/guide/dialyzer.html
@@ -33,18 +33,18 @@ div.navfooter{margin-bottom:1em}
</header>
<main>
-<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ci.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="xref.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="dialyzer"></a>Chapter 24. Dialyzer</h2></div></div></div><p>Dialyzer is a tool that will detect discrepancies in your
+<div class="navheader"><table width="100%" summary="Navigation header"><tr><td width="20%" align="left"><a accesskey="p" href="ci.html">Prev</a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="xref.html">Next</a></td></tr></table><hr /></div><div class="chapter"><div class="titlepage"><div><div><h2 class="title"><a id="dialyzer"></a>Chapter 25. Dialyzer</h2></div></div></div><p>Dialyzer is a tool that will detect discrepancies in your
program. It does so using a technique known as success
typing analysis which has the advantage of providing no
false positives. Dialyzer is able to detect type errors,
-dead code and more.</p><p>Erlang.mk provides a wrapper around Dialyzer.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_how_it_works"></a>24.1. How it works</h2></div></div></div><p>Dialyzer requires a PLT file to work. The PLT file contains
+dead code and more.</p><p>Erlang.mk provides a wrapper around Dialyzer.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_how_it_works"></a>25.1. How it works</h2></div></div></div><p>Dialyzer requires a PLT file to work. The PLT file contains
the analysis information from all applications which are not
expected to change, or rarely do. These would be all the
dependencies of the application or applications you are
currently working on, including standard applications in
Erlang/OTP itself.</p><p>Dialyzer can generate this PLT file. Erlang.mk includes rules
to automatically generate the PLT file when it is missing.</p><p>Once the PLT file is generated, Dialyzer can perform the
-analysis in record time.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_8"></a>24.2. Configuration</h2></div></div></div><p>In a typical usage scenario, no variable needs to be set.
+analysis in record time.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_configuration_8"></a>25.2. Configuration</h2></div></div></div><p>In a typical usage scenario, no variable needs to be set.
The defaults should be enough. Do note however that the
dependencies need to be set properly using the <code class="literal">DEPS</code> and
<code class="literal">LOCAL_DEPS</code> variables.</p><p>The <code class="literal">DIALYZER_PLT</code> file indicates where the PLT file will
@@ -59,10 +59,10 @@ The former one defines which directories should be part
of the analysis. The latter defines what extra warnings
Dialyzer should report.</p><p>Note that Erlang.mk enables the race condition warnings
by default. As it can take considerably large resources
-to run, you may want to disable it on larger projects.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage_6"></a>24.3. Usage</h2></div></div></div><p>To perform an analysis, run the following command:</p><pre class="programlisting">$ make dialyze</pre><p>This will create the PLT file if it doesn’t exist.</p><p>The analysis will also be performed when you run the
+to run, you may want to disable it on larger projects.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_usage_6"></a>25.3. Usage</h2></div></div></div><p>To perform an analysis, run the following command:</p><pre class="programlisting">$ make dialyze</pre><p>This will create the PLT file if it doesn’t exist.</p><p>The analysis will also be performed when you run the
following command, alongside tests:</p><pre class="programlisting">$ make check</pre><p>You can use the <code class="literal">plt</code> target to create the PLT file if
it doesn’t exist. This is normally not necessary as
-Dialyzer creates it automatically.</p><p>The PLT file will be removed when you run <code class="literal">make distclean</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_dialyzing_beam_files"></a>24.4. Dialyzing beam files</h2></div></div></div><p>By default Erlang.mk will run Dialyzer against the source
+Dialyzer creates it automatically.</p><p>The PLT file will be removed when you run <code class="literal">make distclean</code>.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_dialyzing_beam_files"></a>25.4. Dialyzing beam files</h2></div></div></div><p>By default Erlang.mk will run Dialyzer against the source
code. It is possible to configure Erlang.mk to use the
compiled source files instead. This is done using the
<code class="literal">DIALYZER_DIRS</code> variable:</p><pre class="programlisting">DIALYZER_DIRS = -r ebin</pre><p>This value must be set before including Erlang.mk to