Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 188 lines (130 sloc) 5.47 kB
c466076 @tuncer Clean up emacs file local variables
tuncer authored
1 %% -*- mode: erlang;erlang-indent-level: 4;indent-tabs-mode: nil -*-
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
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
11 %% == Erlang Compiler ==
12
13 %% Erlang files to compile before the rest. Rebar automatically compiles
14 %% parse_transforms and custom behaviours before anything other than the files
15 %% in this list.
16 {erl_first_files, ["mymib1", "mymib2"]}.
17
18 %% Erlang compiler options
be209f2 @tuncer Make debug_info default
tuncer authored
19 {erl_opts, [no_debug_info, {i, "myinclude"}, {src_dirs, ["src1", "src2"]},
952b838 @tuncer Document platform_define in sample config
tuncer authored
20 {platform_define,
d203ff1 @tuncer Fix whitespace error in rebar.config.sample
tuncer authored
21 "(linux|solaris|freebsd|darwin)", 'HAVE_SENDFILE'},
5b05e54 @norton Add otp_release to platform string
norton authored
22 {platform_define, "(linux|freebsd)", 'BACKLOG', 128},
23 {platform_define, "R13", 'old_inets'}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
24
25 %% MIB Options?
26 {mib_opts, []}.
27
28 %% SNMP mibs to compile first?
29 {mib_first_files, []}.
30
9cafd06 @Vagabond Document edoc_opts
Vagabond authored
31 %% == EDoc ==
32
33 %% EDoc options
34 {edoc_opts, []}.
35
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
36 %% == Port Compiler ==
37
38 %% Port compilation environment variables. See rebar_port_compiler.erl for
39 %% more info. Default is `[]'
7c418ed @tuncer Add support for target-specific port options
tuncer authored
40 {port_env, [{"CFLAGS", "$CFLAGS -Ifoo"},
41 {"freebsd", "LDFLAGS", "$LDFLAGS -lfoo"}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
42
6898eff @tuncer Rework port compiler support
tuncer authored
43 %% port_specs
44 %% List of filenames or wildcards to be compiled. May also contain a tuple
45 %% consisting of a regular expression to be applied against the system
46 %% architecture as a filter.
47 {port_specs, [{"priv/so_name.so", ["c_src/*.c"]},
7c418ed @tuncer Add support for target-specific port options
tuncer authored
48 {"linux", "priv/hello_linux", ["c_src/hello_linux.c"]},
49 {"linux", "priv/hello_linux", ["c_src/*.c"], [{env, []}]}}.
8711d95 @tuncer Document so_specs
tuncer authored
50
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
51 %% == LFE Compiler ==
52
53 %% LFE files to compile before the rest
54 {lfe_first_files, []}.
55
67af251 @tuncer Remove lfe_opts (suggested by Tim Dysinger)
tuncer authored
56 %% Options for the LFE compiler: reuse {erl_opts, []}
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
57
58 %% == ErlyDTL Compiler ==
59
60 %% Options for the ErlyDTL compiler
61 {erlydtl_opts, []}.
62
63 %% == EUnit ==
64
65 %% Options for eunit:test()
66 {eunit_opts, []}.
67
99b645e @tuncer Separate eunit and qc compile options
tuncer authored
68 %% Additional compile options for eunit. erl_opts is also used
69 {eunit_compile_opts, []}.
70
71 %% Same as erl_first_files, but used only when running 'eunit'
72 {eunit_first_files, []}.
73
74 %% == Cover ==
75
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
76 %% Whether to enable coverage reporting. Default is `false'
77 {cover_enabled, false}.
f2244b2 @Vagabond Add optional eunit coverage report to terminal
Vagabond authored
78
79 %% Whether to print coverage report to console. Default is `false'
80 {cover_print_enabled, false}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
81
43d5b62 @freke Enable export of cover data from eunit testrun
freke authored
82 %% Whether to export coverage report to file. Default is `false'
83 {cover_export_enabled, false}.
84
2d38597 @hyperthunk Pass extra params to ct (thanks Mickael Remond)
hyperthunk authored
85 %% == Common Test ==
86
286a2a8 @hyperthunk Add support for customising common test directory
hyperthunk authored
87 %% Override the default "test" directory in which SUITEs are located
88 {ct_dir, "itest"}.
89
f1d35f9 @DeadZen Add ct_log_dir option, skip test dir with no SUITE
DeadZen authored
90 %% Override the default "logs" directory in which SUITEs are logged
91 {ct_log_dir, "test/logs"}.
92
2d38597 @hyperthunk Pass extra params to ct (thanks Mickael Remond)
hyperthunk authored
93 %% Option to pass extra parameters when launching Common Test
94 {ct_extra_params, "-boot start_sasl -s myapp"}.
95
bebd9d2 @hyperthunk Support ct_run using short name
hyperthunk authored
96 %% Option to use short names (i.e., -sname test) when starting ct
97 {ct_use_short_names, true}.
98
e75a97a @tuncer Add 'qc' cmd and rename eunit-compile to test-compile
tuncer authored
99 %% == QuickCheck ==
100
101 %% If qc_mod is unspecified, rebar tries to detect Triq or EQC
102 {qc_opts, [{qc_mod, module()}, Options]}.
103
99b645e @tuncer Separate eunit and qc compile options
tuncer authored
104 %% Additional compile options for qc. erl_opts is also used
105 {qc_compile_opts, []}.
106
107 %% Same as erl_first_files, but used only when running 'qc'
108 {qc_first_files, []}.
109
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
110 %% == Cleanup ==
111
112 %% Which files to cleanup
113 {clean_files, ["file", "file2"]}.
114
115 %% == Reltool ==
116
117 %% Target directory for the release
118 {target, "target"}.
119
120 %% == OTP Applications ==
121
122 %% Binaries to link into the erlang path?
123 {app_bin, []}.
124
852edb0 @tuncer Document validate_app_modules option
tuncer authored
125 %% Enable validation of the OTP app module list. Default is 'true'
126 {validate_app_modules, true}.
127
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
128 %% == Dependencies ==
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
129
b65d590 @tuncer Fix deps_dir sample config
tuncer authored
130 %% Where to put any downloaded dependencies. Default is "deps"
131 {deps_dir, "deps"}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
132
f4817ca @djui Fix typo: 'dependency'
djui authored
133 %% What dependencies we have, dependencies can be of 3 forms, an application
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
134 %% name as an atom, eg. mochiweb, a name and a version (from the .app file), or
135 %% an application name, a version and the SCM details on how to fetch it (SCM
f38c0b0 @danielwhite Document availability of rsync for fetching deps in rebar.config.sample
danielwhite authored
136 %% type, location and revision).
137 %% Rebar currently supports git, hg, bzr, svn, and rsync.
5d78928 @dizzyd Fix bug 549; example deps in rebar.config.sample were wrong, as ident…
dizzyd authored
138 {deps, [application_name,
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
139 {application_name, "1.0.*"},
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
140 {application_name, "1.0.*",
32ddef7 @tuncer Remove alt_url support in favor of new features
tuncer authored
141 {git, "git://github.com/basho/rebar.git", {branch, "master"}}}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
142
143 %% == Subdirectories ==
144
145 %% Subdirectories?
146 {sub_dirs, ["dir1", "dir2"]}.
e767705 @hyperthunk Add pre and post script support for all commands
hyperthunk authored
147
3b58935 @hyperthunk Load plugins dynamically from source
hyperthunk authored
148 %% == Plugins ==
149
150 %% Plugins you wish to include.
151 %% These can include any module on the code path, including deps.
152 %% Alternatively, plugins can be placed as source files in the plugin_dir, in
153 %% which case they will be compiled and loaded dynamically at runtime.
154 {plugins, [plugin1, plugin2]}.
155
156 %% Override the directory in which plugin sources can be found.
157 %% Defaults to ./plugins
158 {plugin_dir, "some_other_directory"}.
159
160
e767705 @hyperthunk Add pre and post script support for all commands
hyperthunk authored
161 %% == Pre/Post Command Hooks ==
162
163 {pre_hooks, [{clean, "./prepare_package_files.sh"},
8f4e80b @tuncer Update sample hooks config
tuncer authored
164 {"linux", compile, "c_src/build_linux.sh"},
165 {compile, "escript generate_headers"},
166 {compile, "escript check_headers"}]}.
e767705 @hyperthunk Add pre and post script support for all commands
hyperthunk authored
167
168 {post_hooks, [{clean, "touch file1.out"},
8f4e80b @tuncer Update sample hooks config
tuncer authored
169 {"freebsd", compile, "c_src/freebsd_tweaks.sh"},
e767705 @hyperthunk Add pre and post script support for all commands
hyperthunk authored
170 {eunit, "touch file2.out"},
171 {compile, "touch postcompile.out"}]}.
db706ab @tuncer Document xref options
tuncer authored
172
173 %% == xref ==
174
175 {xref_warnings, false}.
0191806 @xcurry Add support for custom xref queries
xcurry authored
176
db706ab @tuncer Document xref options
tuncer authored
177 %% xref checks to run
178 {xref_checks, [exports_not_used, undefined_function_calls]}.
0191806 @xcurry Add support for custom xref queries
xcurry authored
179
180 %% Optional custom xref queries (xref manual has details) specified as
181 %% {xref_queries, [{query_string(), expected_query_result()},...]}
182 %% The following for example removes all references to ejabberd:*_msg/4
183 %% functions from undefined external function calls as those are in a
184 %% generated module
185 {xref_queries,
0b8ca93 @tuncer Fix whitespace error
tuncer authored
186 [{"(XC - UC) || (XU - X - B"
187 " - (\"ejabberd_logger\":\".*_msg\"/\"4\"))",[]}]}.
Something went wrong with that request. Please try again.