summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTuncer Ayaz <tuncer.ayaz@gmail.com>2012-07-01 22:56:07 +0200
committerTuncer Ayaz <tuncer.ayaz@gmail.com>2012-07-01 23:18:40 +0200
commit000a834144509d9a1b46966ff8f70645f648f188 (patch)
tree9336b442ba83e30281b1e4e00a98179aec262866
parent35ef3631b4aa1850a10993c683b9f6253e089c3d (diff)
Update README
-rw-r--r--README.md43
1 files changed, 14 insertions, 29 deletions
diff --git a/README.md b/README.md
index 9dfb1dc..51a9a19 100644
--- a/README.md
+++ b/README.md
@@ -73,8 +73,8 @@ Do not mix spaces and tabs.
Do not introduce lines longer than 80 characters.
[erlang-mode (emacs)](http://www.erlang.org/doc/man/erlang.el.html) indentation is preferred.
-vi-only users are encouraged to give [Vim emulation](http://emacswiki.org/emacs/Evil)
-([more info](https://gitorious.org/evil/pages/Home)) a try.
+vi-only users are encouraged to
+give [Vim emulation](http://emacswiki.org/emacs/Evil) ([more info](https://gitorious.org/evil/pages/Home)) a try.
Writing Commit Messages
-----------------------
@@ -108,41 +108,26 @@ Longer description (wrap at 72 characters)
* Break up logical changes
* Make whitespace changes separately
-Dialyzer and Tidier
--------------------
+Run checks
+----------
-Before you submit a patch check for
+Before you submit a patch, run ``make check`` to execute
+the test suite and check for
[xref](http://www.erlang.org/doc/man/xref.html) and
[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html)
warnings.
-A successful run of ``make check`` looks like:
-
-```sh
-$ make check
-Recompile: src/rebar_core
-==> rebar (compile)
-Command 'debug' not understood or not applicable
-Congratulations! You now have a self-contained script called "rebar" in
-your current working directory. Place this script anywhere in your path
-and you can use rebar to build OTP-compliant apps.
-==> rebar (xref)
-make: [dialyzer_warnings] Error 2 (ignored)
-```
-
[Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) warnings are compared
-against a set of safe-to-ignore warnings found in
-[dialyzer_reference](https://raw.github.com/basho/rebar/master/dialyzer_reference).
+against a set of safe-to-ignore warnings found in
+[dialyzer_reference](https://raw.github.com/basho/rebar/master/dialyzer_reference).
[xref](http://www.erlang.org/doc/man/xref.html) is run with
[custom queries](https://raw.github.com/basho/rebar/master/rebar.config)
to suppress safe-to-ignore warnings.
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.
+[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.