diff options
Diffstat (limited to 'docs/en/erlang.mk/1/guide/dialyzer/index.html')
| -rw-r--r-- | docs/en/erlang.mk/1/guide/dialyzer/index.html | 84 |
1 files changed, 22 insertions, 62 deletions
diff --git a/docs/en/erlang.mk/1/guide/dialyzer/index.html b/docs/en/erlang.mk/1/guide/dialyzer/index.html index fedd4cae..e548daf4 100644 --- a/docs/en/erlang.mk/1/guide/dialyzer/index.html +++ b/docs/en/erlang.mk/1/guide/dialyzer/index.html @@ -62,77 +62,37 @@ <h1 class="lined-header"><span>Dialyzer</span></h1> -<div class="paragraph"><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></div> -<div class="paragraph"><p>Erlang.mk provides a wrapper around Dialyzer.</p></div> -<div class="sect1"> +<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> <h2 id="_how_it_works">How it works</h2> -<div class="sectionbody"> -<div class="paragraph"><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></div> -<div class="paragraph"><p>Dialyzer can generate this PLT file. Erlang.mk includes rules -to automatically generate the PLT file when it is missing.</p></div> -<div class="paragraph"><p>Once the PLT file is generated, Dialyzer can perform the -analysis in record time.</p></div> -</div> -</div> -<div class="sect1"> +<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> <h2 id="_configuration">Configuration</h2> -<div class="sectionbody"> -<div class="paragraph"><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>DEPS</code> and -<code>LOCAL_DEPS</code> variables.</p></div> -<div class="paragraph"><p>The <code>DIALYZER_PLT</code> file indicates where the PLT file will -be written to (and read from). By default this is -<em>$(PROJECT).plt</em> in the project’s directory. Note that -the <code>DIALYZER_PLT</code> variable is exported and is understood -by Dialyzer directly.</p></div> -<div class="paragraph"><p>The <code>PLT_APPS</code> variable can be used to add additional -applications to the PLT. You can either list application -names or paths to these applications.</p></div> -<div class="paragraph"><p>Erlang.mk defines two variables for specifying options -for the analysis: <code>DIALYZER_DIRS</code> and <code>DIALYZER_OPTS</code>. -The former one defines which directories should be part -of the analysis. The latter defines what extra warnings -Dialyzer should report.</p></div> -<div class="paragraph"><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> -</div> -<div class="sect1"> +<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>DEPS</code> and <code>LOCAL_DEPS</code> variables.</p> +<p>The <code>DIALYZER_PLT</code> file indicates where the PLT file will be written to (and read from). By default this is <em>$(PROJECT).plt</em> in the project's directory. Note that the <code>DIALYZER_PLT</code> variable is exported and is understood by Dialyzer directly.</p> +<p>The <code>PLT_APPS</code> variable can be used to add additional applications to the PLT. You can either list application names or paths to these applications.</p> +<p>Erlang.mk defines two variables for specifying options for the analysis: <code>DIALYZER_DIRS</code> and <code>DIALYZER_OPTS</code>. 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> <h2 id="_usage">Usage</h2> -<div class="sectionbody"> -<div class="paragraph"><p>To perform an analysis, run the following command:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<p>To perform an analysis, run the following command:</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 dialyze</tt></pre></div></div> -<div class="paragraph"><p>This will create the PLT file if it doesn’t exist.</p></div> -<div class="paragraph"><p>The analysis will also be performed when you run the -following command, alongside tests:</p></div> -<div class="listingblock"> -<div class="content"><!-- Generator: GNU source-highlight +<pre><tt>$ make dialyze</tt></pre> +</div></div> +<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> +<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 check</tt></pre></div></div> -<div class="paragraph"><p>You can use the <code>plt</code> target to create the PLT file if -it doesn’t exist. This is normally not necessary as -Dialyzer creates it automatically.</p></div> -<div class="paragraph"><p>The PLT file will be removed when you run <code>make distclean</code>.</p></div> -</div> -</div> +<pre><tt>$ make check</tt></pre> +</div></div> +<p>You can use the <code>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>make distclean</code>.</p> + |