github/rebar
1
0
Fork 0
mirror of https://github.com/correl/rebar.git synced 2024-11-23 19:19:54 +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.
855 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
Amit Kapoor 0191806f92 Add support for custom xref queries 
The custom queries are configured in rebar.config via the tuple
{xref_queries, [{query(), query_result()},...]}.  The implementation
passes the query() string to xref:q and compares the return value with
query_result(). It will result in an error if they do not match.

The following configuration, for example, is the same as running the
xref check undefined_function_calls. It additionally filters
ejabberd_logger:*_msg/4 from the result as these functions are generated
on execution by ejabberd and not available at compile time.

{xref_queries, [{"(XC - UC) || (XU - X - B -
                 (\"ejabberd_logger\":\".*_msg\"/\"4\"))",[]}]}.

This patch also modifies the build process of this package by running a
custom query instead of doing a diff against a static xref_warning file.
2012-04-02 19:14:37 +02:00
ebin Remove duplicate entry (Reported-by: Siri Hansen) 2011-07-08 13:08:07 +02:00
include Add rebar_utils:deprecated/4 and remove define 2011-12-12 17:52:04 +01:00
inttest Add support for customising common test directory 2011-12-28 12:41:36 +01:00
priv Add support for alternate dependency urls 2012-03-31 19:21:25 +02:00
src Add support for custom xref queries 2012-04-02 19:14:37 +02:00
test add more info to readme 2012-03-31 13:05:02 -07:00
.gitignore Enhance make check (Inspired-by: Stavros Aronis) 2012-01-01 17:04:37 +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 Fix typos in generated cmd script in bootstrap 2012-02-16 19:09: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
dialyzer_reference Deprecate port_envs in favor of port_env 2012-03-09 20:21:26 +01:00
LICENSE Added HACKING, LICENSE and THANKS files 2009-12-31 20:31:22 +01:00
Makefile Add support for custom xref queries 2012-04-02 19:14:37 +02:00
NOTES.org Initial commit 2009-11-25 15:23:42 -07:00
README.md Enhance make check (Inspired-by: Stavros Aronis) 2012-01-01 17:04:37 +01:00
rebar.config Add support for custom xref queries 2012-04-02 19:14:37 +02:00
rebar.config.sample Add support for custom xref queries 2012-04-02 19:14:37 +02:00
THANKS Add Adam Schepis to THANKS file 2012-03-31 19:21:31 +02: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 here (more info).

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 xref and Dialyzer warnings.

A successful run of make check looks like:

$ 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.
make: [xref_warnings] Error 1 (ignored)
make: [dialyzer_warnings] Error 2 (ignored)

xref and Dialyzer warnings are compared against a set of safe-to-ignore warnings
found in dialyzer_reference and xref_reference.

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.