diff options
Diffstat (limited to 'overlays/index.md')
-rw-r--r-- | overlays/index.md | 52 |
1 files changed, 27 insertions, 25 deletions
diff --git a/overlays/index.md b/overlays/index.md index a6b6c4e..dece340 100644 --- a/overlays/index.md +++ b/overlays/index.md @@ -11,12 +11,14 @@ can take your Overlay configuration and move it to your `relx.config` and it should just work. For example, you could take the following: +{% highlight erl %} {overlay_vars, "vars.config"}. {overlay, [{mkdir, "log/sasl"}, {copy, "files/erl", "{{erts_vsn}}/bin/erl"}, {copy, "files/nodetool", "{{erts_vsn}}/bin/nodetool"}, {template, "files/app.config", "etc/app.config"}, {template, "files/vm.args", "etc/vm.args"}]}. +{% endhighlight %} and move it directly from your `reltool.config` to your `relx.config` and it would work in exactly the same way. In Relx @@ -29,28 +31,28 @@ supported are listed below. Available Variables ------------------- -* *log* : The current log level in the format of `(<logname>:<loglevel>)` -* *output_dir* : The current output directory for the built release -* *target_dir* : The same as `output_dir`, exists for backwards compatibility -* *overridden* : The current list of overridden apps (a list of app names) -* *overrides.<AppName>* : The override directory for said <AppName> -* *goals* : The list of user specified goals in the system -* *lib_dirs* : The list of library directories, both user specified and derived -* *config_file* : The list of config file used in the system -* *providers* : The list of provider names used for this run of relx -* *sys_config* : The location of the sys config file -* *root_dir* : The root dir of the current project -* *default_release_name* : The current default release name for the relx run -* *default_release_version* : The current default release version for the relx run -* *default_release* : The current default release for the relx run -* *release_erts_version* : The version of the Erlang Runtime System in use -* *erts_vsn* : The same as `release_erts_vsn` (for backwards compatibility) -* *release_name* : The currently executing release -* *release_version* : the currently executing version -* *rel_vsn* : Same as `release_version`. Exists for backwards compatibility -* *release_applications* : A list of applications included in the release -* *release.[AppName].version : The version of `<AppName>` -* *release.[AppName].dir : The on system directory of `<AppName>` -* *release.[AppName].active_dependencies : The list of active application dependencies for `<AppName>` -* *release.[AppName].library_dependencies : The list of library application dependencies for `<AppName>` -* *release.[AppName].link : Indicates if this application should be linked in or not +* log : The current log level in the format of `(<logname>:<loglevel>)` +* output_dir : The current output directory for the built release +* target_dir : The same as `output_dir`, exists for backwards compatibility +* overridden : The current list of overridden apps (a list of app names) +* overrides.AppName : The override directory for said AppName +* goals : The list of user specified goals in the system +* lib_dirs : The list of library directories, both user specified and derived +* config_file : The list of config file used in the system +* providers : The list of provider names used for this run of relx +* sys_config : The location of the sys config file +* root_dir : The root dir of the current project +* default_release_name : The current default release name for the relx run +* default_release_version : The current default release version for the relx run +* default_release : The current default release for the relx run +* release_erts_version : The version of the Erlang Runtime System in use +* erts_vsn : The same as `release_erts_vsn` (for backwards compatibility) +* release_name : The currently executing release +* release_version : the currently executing version +* rel_vsn : Same as `release_version`. Exists for backwards compatibility +* release_applications : A list of applications included in the release +* release.AppName.version : The version of `AppName` +* release.AppName.dir : The on system directory of `AppName` +* release.AppName.active_dependencies : The list of active application dependencies for `AppName` +* release.AppName.library_dependencies : The list of library application dependencies for `AppName` +* release.AppName.link : Indicates if this application should be linked in or not |