Erlang build tool that makes it easy to compile and test Erlang applications, port drivers and releases.
Find a file
Andrew Thompson 310a1bb7ea New eunit param skip_app, allow suite to be a list
This patch allows the 'suite' argument to eunit to be a comma separated
list of modules to test instead of being a single module. This allows
fine-grained testing when one test suite interferes with another and its
not clear which suite is causing the problem. It also lets you run the
test suite in a different order for a similar reason.

The other enhancement is to add a new eunit parameter; 'skip_app' which
like 'app' is a comma separated list of modules to skip testing on. This
parameter is only applied if the app parameter is not passed. Its
purpose is to avoid forcing you to specify all the apps to test if you
only want to skip a handful and there are many apps to test.
2011-04-06 18:56:35 +02:00
ebin Add 'generate-appups' command 2011-02-15 18:33:18 +01:00
include Clean up specs 2011-03-28 18:39:38 +02:00
inttest Add pre and post script support for all commands 2011-03-12 16:31:41 +01:00
priv Make debug_info default 2011-03-30 11:19:37 +02:00
src New eunit param skip_app, allow suite to be a list 2011-04-06 18:56:35 +02:00
test Update runner script in test project 2011-03-04 19:39:45 +01:00
.gitignore Ignore .eunit 2010-12-08 12:05:02 +01:00
.hgignore Add .gitignore to the source tree 2010-10-03 16:00:15 +02:00
.hgtags Added tag RELEASE-1 for changeset e8747041ef63 2009-12-18 15:11:54 -07:00
bootstrap Clean up emacs file local variables 2011-01-31 17:55:36 +01:00
bootstrap.bat add bat scripts for bootstrap and rebat (windows doesn't understand shebang), make bootstrap work on windows 2010-08-02 20:35:26 +03:00
LICENSE Added HACKING, LICENSE and THANKS files 2009-12-31 20:31:22 +01:00
Makefile Add "clean" target 2010-06-08 13:23:36 -06:00
NOTES.org Initial commit 2009-11-25 15:23:42 -07:00
README.md Update README: file local variables 2011-03-10 14:42:45 +01:00
rebar.bat Set local scope for env vars in rebar.bat 2011-01-12 17:17:34 +01:00
rebar.config Make debug_info default 2011-03-30 11:19:37 +02:00
rebar.config.sample Make debug_info default 2011-03-30 11:19:37 +02:00
THANKS Add Jordi Chacon to THANKS file 2011-03-26 12:25:44 +01:00

rebar

rebar is an Erlang build tool that makes it easy to compile and
test Erlang applications, port drivers and releases.

rebar is a self-contained Erlang script, so it's easy to distribute or even
embed directly in a project. Where possible, rebar uses standard Erlang/OTP
conventions for project structures, thus minimizing the amount of build
configuration work. rebar also provides dependency management, enabling
application writers to easily re-use common libraries from a variety of
locations (git, hg, etc).

Building

Information on building and installing Erlang/OTP can be found in the INSTALL.md document.

Dependencies

To build rebar you will need a working installation of Erlang R13B03 (or later).

Should you want to clone the rebar repository, you will also require git.

Downloading

Clone the git repository:

$ git clone git://github.com/basho/rebar.git

Building rebar

$ cd rebar/
$ ./bootstrap
Recompile: src/getopt
...
Recompile: src/rebar_utils
==> rebar (compile)
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.

Contributing to rebar

Coding style

Do not introduce trailing whitespace.

Do not introduce lines longer than 80 characters.

Writing Commit Messages

Structure your commit message like this:

One line summary (less than 50 characters)

Longer description (wrap at 72 characters)

Summary

  • Less than 50 characters
  • What was changed
  • Imperative present tense (fix, add, change)

Fix bug 123
Add 'foobar' command
Change default timeout to 123

  • No period

Description

  • Wrap at 72 characters
  • Why, explain intention and implementation approach
  • Present tense

Atomicity

  • Break up logical changes
  • Make whitespace changes separately

Dialyzer and Tidier

Before you submit a patch check for discrepancies with Dialyzer:

$ cd rebar/
$ ./bootstrap debug
$ dialyzer ebin -Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspecs

The following discrepancies are known and safe to ignore:

rebar_templater.erl:249: The call rebar_templater:consult(
                                Cont1::erl_scan:return_cont(),'eof',
                                Acc::[any()])
                         contains an opaque term as 1st argument when terms
                         of different types are expected in these positions
rebar_utils.erl:144: Call to missing or unexported function escript:foldl/3
rebar_utils.erl:165: The created fun has no local return

It is strongly recommended to check the code with Tidier.
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.