github/rebar
1
0
Fork 0
mirror of https://github.com/correl/rebar.git synced 2024-11-14 19:19:30 +00:00
Code Issues Projects Releases Packages Wiki Activity
Erlang build tool that makes it easy to compile and test Erlang applications, port drivers and releases.
762 commits 5 branches 11 tags 2.8 MiB
Erlang 93.6%
Shell 5.3%
Batchfile 0.6%
C 0.3%
Makefile 0.2%
Find a file
Tuncer Ayaz 54259c5475 Document port_first_files
2011-11-30 19:50:24 +01:00
ebin Remove duplicate entry (Reported-by: Siri Hansen) 2011-07-08 13:08:07 +02:00
include Restore R13B03 compatibility for building rebar 2011-07-28 22:27:54 +02:00
inttest Fix config handling in root_dir 2011-10-05 13:49:27 +02:00
priv Add root_dir= to shell completion 2011-11-26 12:09:39 +01:00
src Add support for first_files to port compiler 2011-11-30 19:39:23 +01:00
test Handle vm.args properly while building upgrades 2011-10-05 20:23:07 -07: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 Reformat bootstrap 2011-08-16 15:26:02 +02: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 Update Dialyzer options 2011-09-04 20:13:25 +02:00
NOTES.org Initial commit 2009-11-25 15:23:42 -07:00
README.md Fix Dialyzer warning 2011-09-08 22:54:44 +02:00
rebar.bat Fix rebar.bat path handling 2011-06-13 19:36:57 +02:00
rebar.config Add file local variables where appropriate 2011-04-15 17:22:49 +02:00
rebar.config.sample Document port_first_files 2011-11-30 19:50:24 +01:00
THANKS Add Smith Winston to THANKS file 2011-11-26 10:38:56 +01:00

README.md

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 Vim emulation (more info) 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:

$ make check

The following discrepancies are known and safe to ignore:

rebar_utils.erl:147: Call to missing or unexported function escript:foldl/3

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.