aboutsummaryrefslogtreecommitdiffstats
path: root/guide/xref.html
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2022-05-31 09:59:21 +0200
committerLoïc Hoguin <[email protected]>2022-05-31 09:59:21 +0200
commitfabea4e496506b7a5089cb2fffbd844a96b2ec41 (patch)
tree76a9b3ecbb0f10610e9726489abefdb6754c291e /guide/xref.html
parentaf8ba863113fe48b1e83f1a760775e03e3148c41 (diff)
downloaderlang.mk-fabea4e496506b7a5089cb2fffbd844a96b2ec41.tar.gz
erlang.mk-fabea4e496506b7a5089cb2fffbd844a96b2ec41.tar.bz2
erlang.mk-fabea4e496506b7a5089cb2fffbd844a96b2ec41.zip
Update user guide
Diffstat (limited to 'guide/xref.html')
-rw-r--r--guide/xref.html4
1 files changed, 2 insertions, 2 deletions
diff --git a/guide/xref.html b/guide/xref.html
index 35ea94e..828146e 100644
--- a/guide/xref.html
+++ b/guide/xref.html
@@ -114,8 +114,8 @@ and Rebar-compatible inline ignores. To ignore
warnings for a function in the current module the
following line can be added to the source file:</p><pre class="programlisting">-ignore_xref({log, 1}).</pre><p>The module name can be specified explicitly:</p><pre class="programlisting">-ignore_xref({my_mod, log, 1}).</pre><p>As well as a full module can be ignored:</p><pre class="programlisting">-ignore_xref(my_mod).</pre><p>The ignored functions can be provided as a list:</p><pre class="programlisting">-ignore_xref([{log, 1}, {pretty_print, 1}]).</pre><p>The <code class="literal">XREF_IGNORE</code> variable can be used to define
functions and modules to ignore project-wide. It
-accepts either MFAs or modules:</p><pre class="programlisting">XREF_IGNORE={my_mod, log, 1}</pre><p>Multiple ignores must be provided as an Erlang
-list:</p><pre class="programlisting">XREF_IGNORE=[{my_mod, log, 1}, other_mod]</pre><p>By default Erlang.mk will ignore unused exports
+accepts either MFAs or modules:</p><pre class="programlisting">XREF_IGNORE = {my_mod, log, 1}</pre><p>Multiple ignores must be provided as an Erlang
+list:</p><pre class="programlisting">XREF_IGNORE = [{my_mod, log, 1}, other_mod]</pre><p>By default Erlang.mk will ignore unused exports
for behavior callbacks when the <code class="literal">exports_not_used</code>
check is run. It is possible to override this
behavior, or to ignore the callbacks for queries