From 1f1793cc5e747c9a937d1f304f8a99f9316f2672 Mon Sep 17 00:00:00 2001 From: Tuncer Ayaz Date: Thu, 13 Jan 2011 16:26:14 +0100 Subject: [PATCH] Update README: Dialyzer and Tidier --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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): + +
+$ cd rebar/
+$ ./bootstrap debug
+$ dialyzer ebin -Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspecs
+
+ +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.