diff options
Diffstat (limited to 'lib/dialyzer/doc/src/dialyzer.xml')
| -rw-r--r-- | lib/dialyzer/doc/src/dialyzer.xml | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/lib/dialyzer/doc/src/dialyzer.xml b/lib/dialyzer/doc/src/dialyzer.xml index 05abcc4daf..334cfcb8d7 100644 --- a/lib/dialyzer/doc/src/dialyzer.xml +++ b/lib/dialyzer/doc/src/dialyzer.xml @@ -507,6 +507,32 @@ dialyzer --plts plt_1 ... plt_n -- files_to_analyze</code> <p>Currently the only option used is the <seeerl marker="#error_location"><c>error_location</c></seeerl> option. </p> + + <p><em>Dialyzer configuration file:</em></p> + + <p>Dialyzer's configuration file may also be used to augment the default + options and those given directly to the Dialyzer command. It is commonly + used to avoid repeating options which would otherwise need to be given + explicitly to Dialyzer on every invocation. + </p> + + <p>The location of the configuration file can be set via the + <c>DIALYZER_CONFIG</c> environment variable, and defaults to + within the <c>user_config</c> from <seemfa marker="stdlib:filename#basedir/3"> + <c>filename:basedir/3</c></seemfa>. + </p> + + <p>An example configuration file's contents might be:</p> + + <code type="none"> + {incremental, + {default_apps,[stdlib,kernel,erts]}, + {default_warning_apps,[stdlib]} + }. + {warnings, [no_improper_lists]}. + {add_pathsa,["/users/samwise/potatoes/ebin"]}. + {add_pathsz,["/users/smeagol/fish/ebin"]}. + </code> </section> <section> @@ -593,6 +619,12 @@ dialyzer --plts plt_1 ... plt_n -- files_to_analyze</code> <name name="file_location"></name> </datatype> <datatype> + <name name="filename_opt"></name> + </datatype> + <datatype> + <name name="format_option"></name> + </datatype> + <datatype> <name name="warn_option"></name> <desc> <p>See section <seeerl |