summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTuncer Ayaz <tuncer.ayaz@gmail.com>2011-01-13 16:26:14 +0100
committerTuncer Ayaz <tuncer.ayaz@gmail.com>2011-01-13 17:38:19 +0100
commit1f1793cc5e747c9a937d1f304f8a99f9316f2672 (patch)
tree11e7a71f4b103c2d4ef47bbb814a250a31a90615 /README.md
parent6d6fbacddb88f5c664790c9d6e355cedaf435314 (diff)
downloadrebar-1f1793cc5e747c9a937d1f304f8a99f9316f2672.tar.gz
Update README: Dialyzer and Tidier
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2050202..16f4541 100644
--- a/README.md
+++ b/README.md
@@ -89,3 +89,25 @@ Longer description (wrap at 72 characters)
* Break up logical changes
* Make whitespace changes separately
+
+Dialyzer and Tidier
+-------------------
+
+Before you submit a patch check for discrepancies with
+[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html):
+
+<pre>
+$ cd rebar/
+$ ./bootstrap debug
+$ dialyzer ebin -Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspecs
+</pre>
+
+It is **strongly recommended** to check the code with
+[Tidier](http://tidier.softlab.ntua.gr:20000/tidier/getstarted).
+Select all transformation options and enable **automatic**
+transformation.
+If Tidier suggests a transformation apply the changes **manually**
+to the source code.
+Do not use the code from the tarball (*out.tgz*) as it will have
+white-space changes
+applied by Erlang's pretty-printer.