Skip to content
Newer
Older
100644 145 lines (98 sloc) 3.85 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
38 %% List and wildcard list of files to be compiled. Default is `"c_src/*.c"'
39 {port_sources, []}.
40
41 %% Port compilation environment variables. See rebar_port_compiler.erl for
42 %% more info. Default is `[]'
43 {port_envs, []}.
44
45 %% Custom name of the port driver .so file. Defaults to `<Application>_drv.so'.
46 {so_name, "driver.so"}.
47
8711d95 @tuncer Document so_specs
tuncer authored
48 %% so_specs - useful for building multiple *.so files
49 %% from one or more object files
50 {so_specs, [{"priv/so_name.so", ["c_src/object_file_name.o"]}]}.
51
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
52 %% == LFE Compiler ==
53
54 %% LFE files to compile before the rest
55 {lfe_first_files, []}.
56
67af251 @tuncer Remove lfe_opts (suggested by Tim Dysinger)
tuncer authored
57 %% Options for the LFE compiler: reuse {erl_opts, []}
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
58
59 %% == ErlyDTL Compiler ==
60
61 %% Options for the ErlyDTL compiler
62 {erlydtl_opts, []}.
63
64 %% == EUnit ==
65
66 %% Options for eunit:test()
67 {eunit_opts, []}.
68
69 %% Additional compile options for eunit. erl_opts from above is also used
70 {eunit_compile_opts, []}.
71
e407838 @tuncer Document eunit_first_files
tuncer authored
72 %% Same as erl_first_files, but used only when running 'eunit'
73 {eunit_first_files, []}.
74
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
75 %% Whether to enable coverage reporting. Default is `false'
76 {cover_enabled, false}.
f2244b2 @Vagabond Add optional eunit coverage report to terminal
Vagabond authored
77
78 %% Whether to print coverage report to console. Default is `false'
79 {cover_print_enabled, false}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
80
2d38597 @hyperthunk Pass extra params to ct (thanks Mickael Remond)
hyperthunk authored
81 %% == Common Test ==
82
83 %% Option to pass extra parameters when launching Common Test
84 {ct_extra_params, "-boot start_sasl -s myapp"}.
85
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
86 %% == Dialyzer ==
87
2d2aed6 @tuncer Refactor Dialyzer support to make it more usable
tuncer authored
88 %% Options for running dialyzer
89 %% {plt, PltFile}
90 %% 'src': run Dialyzer on the source files as in 'dialyzer --src'
91 %% {warnings, [WarnOpts]}: turn on/off Dialyzer warnings
b2e7e5b @tuncer Fix dialyzer_opts documentation
tuncer authored
92 {dialyzer_opts, [{plt, PltFile}, {warnings, [WarnOpts]}, src]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
93
94 %% == Cleanup ==
95
96 %% Which files to cleanup
97 {clean_files, ["file", "file2"]}.
98
99 %% == Reltool ==
100
101 %% Target directory for the release
102 {target, "target"}.
103
104 %% == OTP Applications ==
105
106 %% Binaries to link into the erlang path?
107 {app_bin, []}.
108
852edb0 @tuncer Document validate_app_modules option
tuncer authored
109 %% Enable validation of the OTP app module list. Default is 'true'
110 {validate_app_modules, true}.
111
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
112 %% == Dependencies ==
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
113
114 %% Where to put any downloaded depandencies. Default is `deps'
115 {deps_dir, ["deps"]}.
116
117 %% What dependancies we have, depandencies can be of 3 forms, an application
118 %% name as an atom, eg. mochiweb, a name and a version (from the .app file), or
119 %% an application name, a version and the SCM details on how to fetch it (SCM
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
120 %% 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
121 {deps, [application_name,
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
122 {application_name, "1.0.*"},
86753c4 @tuncer Cleanup rebar.config.sample
tuncer authored
123 {application_name, "1.0.*",
124 {git, "git://github.com/basho/rebar.git", {branch, "master"}}}]}.
cad24b2 @dizzyd Adding rebar.config.sample from vagabond (http://bitbucket.org/vagabo…
dizzyd authored
125
126 %% == Subdirectories ==
127
128 %% Subdirectories?
129 {sub_dirs, ["dir1", "dir2"]}.
e767705 @hyperthunk Add pre and post script support for all commands
hyperthunk authored
130
131 %% == Pre/Post Command Hooks ==
132
133 {pre_hooks, [{clean, "./prepare_package_files.sh"},
134 {compile, "escript generate_headers"}]}.
135
136 {post_hooks, [{clean, "touch file1.out"},
137 {eunit, "touch file2.out"},
138 {compile, "touch postcompile.out"}]}.
db706ab @tuncer Document xref options
tuncer authored
139
140 %% == xref ==
141
142 {xref_warnings, false}.
143 %% xref checks to run
144 {xref_checks, [exports_not_used, undefined_function_calls]}.
Something went wrong with that request. Please try again.