aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2015-05-07 11:54:03 +0300
committerLoïc Hoguin <[email protected]>2015-05-07 11:54:23 +0300
commit6df73b9e519d0253bed626f1dc7f6d043533fb02 (patch)
tree58f7e87aac0f399514d7fe55eb2ff10142bd6beb /README.md
parentb970686c2bc9a2c15d7f8e257885bd153c7a8f0d (diff)
parent1a1915f8caab06860a8d14d17c184128dfea9acc (diff)
downloaderlang.mk-6df73b9e519d0253bed626f1dc7f6d043533fb02.tar.gz
erlang.mk-6df73b9e519d0253bed626f1dc7f6d043533fb02.tar.bz2
erlang.mk-6df73b9e519d0253bed626f1dc7f6d043533fb02.zip
Merge branch 'xref_plugin' of https://github.com/inaka/erlang.mk
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index b3ade31..2c0c4bc 100644
--- a/README.md
+++ b/README.md
@@ -538,6 +538,19 @@ Or:
$ make triq t=cow_http_hd:prop_parse_accept
```
+Xref plugin
+------------
+
+This plugin is available by default. It adds the following
+target:
+
+`xref` Erlang Xref Runner (inspired in rebar's rebar_xref)
+
+The `XREF_CONFIG` variable specifies the location of the
+configuration file which holds the checks to be applied.
+If there is no `xref.config` all `xref` checks will be
+applied to the binaries located in the `/ebin` directory.
+
Contributing
------------