Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 138 lines (94 sloc) 3.74 kb
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
1 %% -*- tab-width: 4;erlang-indent-level: 4;indent-tabs-mode: nil -*-
2 %% ex: ts=4 sw=4 ft=erlang et
3 %% This is a sample rebar.conf file that shows examples of some of rebar's
4 %% options.
5
6 %% == Core ==
7
8 %% Additional library directories to add to the code path
9 {lib_dirs, []}.
10
2387a8e @Vagabond Document the pre and post script hooks
Vagabond authored
11 %% Command to run before compiling
12 {compile_pre_script, "./script.sh"}.
13
14 %% Command to run after compiling
15 {compile_post_script, "./script.sh"}.
16
17 %% Command to run before cleaning
18 {clean_pre_script, "./script.sh"}.
19
20 %% Command to run after cleaning
21 {clean_post_script, "./script.sh"}.
22
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
23 %% == Erlang Compiler ==
24
25 %% Erlang files to compile before the rest. Rebar automatically compiles
26 %% parse_transforms and custom behaviours before anything other than the files
27 %% in this list.
28 {erl_first_files, ["mymib1", "mymib2"]}.
29
30 %% Erlang compiler options
952b838 @tuncer Document platform_define in sample config
tuncer authored
31 {erl_opts, [{i, "myinclude"}, {src_dirs, ["src1", "src2"]},
32 {platform_define,
33 "(linux|solaris|freebsd|darwin)", 'HAVE_SENDFILE'},
5b05e54 @norton Add otp_release to platform string
norton authored
34 {platform_define, "(linux|freebsd)", 'BACKLOG', 128},
35 {platform_define, "R13", 'old_inets'}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
36
37 %% MIB Options?
38 {mib_opts, []}.
39
40 %% SNMP mibs to compile first?
41 {mib_first_files, []}.
42
9cafd06 @Vagabond Document edoc_opts
Vagabond authored
43 %% == EDoc ==
44
45 %% EDoc options
46 {edoc_opts, []}.
47
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
48 %% == Port Compiler ==
49
50 %% List and wildcard list of files to be compiled. Default is `"c_src/*.c"'
51 {port_sources, []}.
52
53 %% Port compilation environment variables. See rebar_port_compiler.erl for
54 %% more info. Default is `[]'
55 {port_envs, []}.
56
57 %% Tuple which specifies a pre-compilation script to run, and a filename that
58 %% exists as a result of the script running.
59 {port_pre_script, {"script.sh", "skipfile"}}.
60
61 %% String that specifies a script to run during cleanup. Use this to remove
62 %% files/directories created by port_pre_script.
63 {port_cleanup_script, "cleanup.sh"}.
64
65 %% Custom name of the port driver .so file. Defaults to `<Application>_drv.so'.
66 {so_name, "driver.so"}.
67
68 %% == LFE Compiler ==
69
70 %% LFE files to compile before the rest
71 {lfe_first_files, []}.
72
73 %% Options for the LFE compiler
74 {lfe_opts, []}.
75
76 %% == ErlyDTL Compiler ==
77
78 %% Options for the ErlyDTL compiler
79 {erlydtl_opts, []}.
80
81 %% == EUnit ==
82
83 %% Options for eunit:test()
84 {eunit_opts, []}.
85
86 %% Additional compile options for eunit. erl_opts from above is also used
87 {eunit_compile_opts, []}.
88
89 %% Whether to enable coverage reporting. Default is `false'
90 {cover_enabled, false}.
f2244b2 @Vagabond Add optional eunit coverage report to terminal
Vagabond authored
91
92 %% Whether to print coverage report to console. Default is `false'
93 {cover_print_enabled, false}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
94
95 %% == Dialyzer ==
96
2d2aed6 @tuncer Refactor Dialyzer support to make it more usable
tuncer authored
97 %% Options for running dialyzer
98 %% {plt, PltFile}
99 %% 'src': run Dialyzer on the source files as in 'dialyzer --src'
100 %% {warnings, [WarnOpts]}: turn on/off Dialyzer warnings
b2e7e5b @tuncer Fix dialyzer_opts documentation
tuncer authored
101 {dialyzer_opts, [{plt, PltFile}, {warnings, [WarnOpts]}, src]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
102
103 %% == Cleanup ==
104
105 %% Which files to cleanup
106 {clean_files, ["file", "file2"]}.
107
108 %% == Reltool ==
109
110 %% Target directory for the release
111 {target, "target"}.
112
113 %% == OTP Applications ==
114
115 %% Binaries to link into the erlang path?
116 {app_bin, []}.
117
852edb0 @tuncer Document validate_app_modules option
tuncer authored
118 %% Enable validation of the OTP app module list. Default is 'true'
119 {validate_app_modules, true}.
120
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
121 %% == Dependancies ==
122
123 %% Where to put any downloaded depandencies. Default is `deps'
124 {deps_dir, ["deps"]}.
125
126 %% What dependancies we have, depandencies can be of 3 forms, an application
127 %% name as an atom, eg. mochiweb, a name and a version (from the .app file), or
128 %% an application name, a version and the SCM details on how to fetch it (SCM
129 %% type, location and revision). Rebar currently support git, hg, bzr and svn.
5d78928 @dizzyd Fix bug 549; example deps in rebar.config.sample were wrong, as identifi...
dizzyd authored
130 {deps, [application_name,
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
131 {application_name, "1.0.*"},
5d78928 @dizzyd Fix bug 549; example deps in rebar.config.sample were wrong, as identifi...
dizzyd authored
132 {application_name, "1.0.*", {hg, "http://bitbucket.org/basho/rebar/", "f3626d5858a6"}}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabond/...
dizzyd authored
133
134 %% == Subdirectories ==
135
136 %% Subdirectories?
137 {sub_dirs, ["dir1", "dir2"]}.
Something went wrong with that request. Please try again.