Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 153 lines (104 sloc) 4.336 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,
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
aef6c70 @andrewtj Change arch-specific port_sources to take a list
andrewtj authored
38 %% List of filenames or wildcards to be compiled. May also contain a tuple
39 %% consisting of a regular expression to be applied against the system
40 %% architecture and a list of filenames or wildcards to include should the
41 %% expression pass. Default is `"c_src/*.c"'
42 {port_sources, ["c_src/*.c", {"R14", ["c_src/*.c"]}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
43
44 %% Port compilation environment variables. See rebar_port_compiler.erl for
45 %% more info. Default is `[]'
46 {port_envs, []}.
47
48 %% Custom name of the port driver .so file. Defaults to `<Application>_drv.so'.
49 {so_name, "driver.so"}.
50
8711d95 @tuncer Document so_specs
tuncer authored
51 %% so_specs - useful for building multiple *.so files
52 %% from one or more object files
53 {so_specs, [{"priv/so_name.so", ["c_src/object_file_name.o"]}]}.
54
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
55 %% == LFE Compiler ==
56
57 %% LFE files to compile before the rest
58 {lfe_first_files, []}.
59
67af251 @tuncer Remove lfe_opts (suggested by Tim Dysinger)
tuncer authored
60 %% Options for the LFE compiler: reuse {erl_opts, []}
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
61
62 %% == ErlyDTL Compiler ==
63
64 %% Options for the ErlyDTL compiler
65 {erlydtl_opts, []}.
66
67 %% == EUnit ==
68
69 %% Options for eunit:test()
70 {eunit_opts, []}.
71
72 %% Additional compile options for eunit. erl_opts from above is also used
73 {eunit_compile_opts, []}.
74
e407838 @tuncer Document eunit_first_files
tuncer authored
75 %% Same as erl_first_files, but used only when running 'eunit'
76 {eunit_first_files, []}.
77
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
78 %% Whether to enable coverage reporting. Default is `false'
79 {cover_enabled, false}.
f2244b2 @Vagabond Add optional eunit coverage report to terminal
Vagabond authored
80
81 %% Whether to print coverage report to console. Default is `false'
82 {cover_print_enabled, false}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
83
2d38597 @hyperthunk Pass extra params to ct (thanks Mickael Remond)
hyperthunk authored
84 %% == Common Test ==
85
86 %% Option to pass extra parameters when launching Common Test
87 {ct_extra_params, "-boot start_sasl -s myapp"}.
88
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
89 %% == Cleanup ==
90
91 %% Which files to cleanup
92 {clean_files, ["file", "file2"]}.
93
94 %% == Reltool ==
95
96 %% Target directory for the release
97 {target, "target"}.
98
99 %% == OTP Applications ==
100
101 %% Binaries to link into the erlang path?
102 {app_bin, []}.
103
852edb0 @tuncer Document validate_app_modules option
tuncer authored
104 %% Enable validation of the OTP app module list. Default is 'true'
105 {validate_app_modules, true}.
106
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
107 %% == Dependencies ==
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
108
f4817ca @djui Fix typo: 'dependency'
djui authored
109 %% Where to put any downloaded dependencies. Default is `deps'
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
110 {deps_dir, ["deps"]}.
111
f4817ca @djui Fix typo: 'dependency'
djui authored
112 %% 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
113 %% name as an atom, eg. mochiweb, a name and a version (from the .app file), or
114 %% an application name, a version and the SCM details on how to fetch it (SCM
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
115 %% type, location and revision). Rebar currently supports git, hg, bzr and svn.
5d78928 @dizzyd Fix bug 549; example deps in rebar.config.sample were wrong, as ident…
dizzyd authored
116 {deps, [application_name,
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
117 {application_name, "1.0.*"},
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
118 {application_name, "1.0.*",
119 {git, "git://github.com/basho/rebar.git", {branch, "master"}}}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
120
121 %% == Subdirectories ==
122
123 %% Subdirectories?
124 {sub_dirs, ["dir1", "dir2"]}.
e767705 @hyperthunk Add pre and post script support for all commands
hyperthunk authored
125
3b58935 @hyperthunk Load plugins dynamically from source
hyperthunk authored
126 %% == Plugins ==
127
128 %% Plugins you wish to include.
129 %% These can include any module on the code path, including deps.
130 %% Alternatively, plugins can be placed as source files in the plugin_dir, in
131 %% which case they will be compiled and loaded dynamically at runtime.
132 {plugins, [plugin1, plugin2]}.
133
134 %% Override the directory in which plugin sources can be found.
135 %% Defaults to ./plugins
136 {plugin_dir, "some_other_directory"}.
137
138
e767705 @hyperthunk Add pre and post script support for all commands
hyperthunk authored
139 %% == Pre/Post Command Hooks ==
140
141 {pre_hooks, [{clean, "./prepare_package_files.sh"},
142 {compile, "escript generate_headers"}]}.
143
144 {post_hooks, [{clean, "touch file1.out"},
145 {eunit, "touch file2.out"},
146 {compile, "touch postcompile.out"}]}.
db706ab @tuncer Document xref options
tuncer authored
147
148 %% == xref ==
149
150 {xref_warnings, false}.
151 %% xref checks to run
152 {xref_checks, [exports_not_used, undefined_function_calls]}.
Something went wrong with that request. Please try again.