Erlang build tool that makes it easy to compile and test Erlang applications, port drivers and releases.
Find a file
Steve Vinoski 0bbb2985f0 Use external wordsize to get emulator build arch
Calling erlang:system_info(wordsize) yields the internal word size of
the Erlang emulator. But due to the halfword emulator, need to pass
{wordsize, external} instead to get the word size, or pointer size, as
seen by external code such as NIFs. The halfword emulator has 4 byte
internal words but 8 byte external words due to 64-bit compilation,
which means NIFs for the halfword emulator also have to be compiled
64-bit. But just passing wordsize is equivalent to passing {wordsize,
internal}, which does not indicate the pointer size for the halfword
emulator.

Older versions of Erlang do not support {wordsize, external}, though,
so continue to pass just wordsize for those versions.
2011-05-31 10:47:45 +02:00
ebin Fix formatting (thanks Piotr Usewicz) 2011-04-15 17:22:55 +02:00
include Deprecate fail_on_warning and refactor code 2011-04-07 21:56:53 +02:00
inttest Add pre and post script support for all commands 2011-03-12 16:31:41 +01:00
priv Fix formatting (thanks Piotr Usewicz) 2011-04-15 17:22:55 +02:00
src Use external wordsize to get emulator build arch 2011-05-31 10:47:45 +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: fix formatting 2011-05-21 12:58:43 +02:00
rebar.bat Set local scope for env vars in rebar.bat 2011-01-12 17:17:34 +01:00
rebar.config Add file local variables where appropriate 2011-04-15 17:22:49 +02:00
rebar.config.sample Change arch-specific port_sources to take a list 2011-05-28 15:31:51 +02:00
THANKS Remove duplicate entry in THANKS 2011-05-26 07:13:42 +02: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

Pull requests and branching

Use one topic branch per pull request.

Do not commit to master in your fork.

Provide a clean branch without any merge commits from upstream.

Usually you should squash any intermediate commits into the original single commit.

Code style

Do not introduce trailing whitespace.

Do not mix spaces and tabs.

Do not introduce lines longer than 80 characters.

erlang-mode (emacs) indentation is preferred. vi-only users are encouraged to give Vimpulse a try.

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_utils.erl:147: Call to missing or unexported function escript:foldl/3
rebar_utils.erl:180: 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.