aboutsummaryrefslogtreecommitdiffstats
path: root/examples/relx.config
diff options
context:
space:
mode:
authorEric Merritt <[email protected]>2013-11-22 06:50:09 -0800
committerEric Merritt <[email protected]>2013-11-22 06:50:09 -0800
commit6316901dfe96c4fbfe30e1d2759d40568b767dd0 (patch)
tree6eb1228fd544b5b2d2735e9368966e06f9985c73 /examples/relx.config
parentdbe33118562ea1c223dcb728912f9ed3c770cfec (diff)
parent2233b403fbab271cc92690b72f61c3a80f36f6cf (diff)
downloadrelx-6316901dfe96c4fbfe30e1d2759d40568b767dd0.tar.gz
relx-6316901dfe96c4fbfe30e1d2759d40568b767dd0.tar.bz2
relx-6316901dfe96c4fbfe30e1d2759d40568b767dd0.zip
Merge pull request #92 from byaruhaf/patch-2
Updated comments replaced relcool with relx
Diffstat (limited to 'examples/relx.config')
-rw-r--r--examples/relx.config34
1 files changed, 17 insertions, 17 deletions
diff --git a/examples/relx.config b/examples/relx.config
index 77d7acf..f328c32 100644
--- a/examples/relx.config
+++ b/examples/relx.config
@@ -1,11 +1,11 @@
%% -*- mode: Erlang; fill-column: 80; comment-column: 75; -*-
-%% Example Relcool Config
+%% Example Relx Config
%% ======================
%%
-%% This is an example relcool config whose purpose is to demonstrate all of the
-%% options available in relcool. Its not expected that you will use all of the
-%% things here. In fact, there is a high likely hood that *your* relcool.config
-%% will be extremely minimal, as relcool does a very good job of figuring out
+%% This is an example relx config whose purpose is to demonstrate all of the
+%% options available in relx. Its not expected that you will use all of the
+%% things here. In fact, there is a high likely hood that *your* relx.config
+%% will be extremely minimal, as relx does a very good job of figuring out
%% things on its own.
%%
%% The Release We Are Building
@@ -17,10 +17,10 @@
%% neotoma (any version). We also do not want neotoma to be loaded. We also want
%% our default release. the one we build in the common case to be sexper 0.0.2.
-%% You can tell relcool about additional directories that you want searched for
+%% You can tell relx about additional directories that you want searched for
%% otp apps during the discovery process. You do that in the 'paths' config. You
%% can also specify these paths on the command line with `-p`. Be aware that
-%% relcool plays well with rebar so if you have a deps directory in the current
+%% relx plays well with rebar so if you have a deps directory in the current
%% directory it will be automatically added.
{paths, ["/opt/erlang_apps"]}.
@@ -28,13 +28,13 @@
%% one automatically generated by relx.
{vm_args, "./config/vm.args"}.
-%% If you have a sys.config file you need to tell relcool where it is. If you do
-%% that relcool will include the sys.config in the appropriate place
+%% If you have a sys.config file you need to tell relx where it is. If you do
+%% that relx will include the sys.config in the appropriate place
%% automatically.
{sys_config, "./config/sys.config"}.
%% relcool will include erts by default. However, if you don't want to include
-%% erts you can add the `include_erts` tuple to the config and tell relcool not
+%% erts you can add the `include_erts` tuple to the config and tell relx not
%% to include it.
{include_erts, false}.
@@ -42,9 +42,9 @@
%% script add the extended_start_script option.
{extended_start_script, true}.
-%% When we have multiple releases relcool needs to know which one to build. You
+%% When we have multiple releases relx needs to know which one to build. You
%% can specify that on the command line with the `-n` and `-v` arguments to
-%% relcool. However, it is often more convenient to do it in the config.
+%% relx. However, it is often more convenient to do it in the config.
{default_release, sexpr, "0.0.2"}.
{release, {sexpr, "0.0.1"},
@@ -67,15 +67,15 @@
%% During development its often the case that you want to substitute the app
%% that you are working on for a 'production' version of an app. You can
-%% explicitly tell relcool to override all versions of an app that you specify
-%% with an app in an arbitrary directory. Relcool will then symlink that app
-%% into the release in place of the specified app. be aware though that relcool
+%% explicitly tell relx to override all versions of an app that you specify
+%% with an app in an arbitrary directory. relx will then symlink that app
+%% into the release in place of the specified app. be aware though that relx
%% will check your app for consistancy so it should be a normal OTP app and
%% already be built.
{overrides, [{sexpr, "../sexpr"}]}.
-%% In some cases you might want to add additional functionality to relcool. You
-%% can do this via a 'provider'. A provider is an implementation of the relcool
+%% In some cases you might want to add additional functionality to relx. You
+%% can do this via a 'provider'. A provider is an implementation of the relx
%% provider behaviour. This probably shouldn't be needed very often.
{add_providers, [my_custom_functionality]}.