| Overview |  |
Copyright © (C) 2012 Erlware, LLC.
Authors: Eric Merritt (ericbmerritt@gmail.com).
mode() = dev | prod | minimal
releases() = #{{rlx_release:name(), rlx_release:vsn()} => rlx_release:t()}
t() = #state_t{root_dir = file:name(), output_dir = file:name(), lib_dirs = [file:name()], config_file = file:filename() | undefined, available_apps = #{atom() => rlx_app_info:t()}, vm_args = file:filename() | false | undefined, vm_args_src = file:filename() | false | undefined, sys_config = file:filename() | false | undefined, sys_config_src = file:filename() | false | undefined, overrides = [{AppName::atom(), Directory::file:filename()}], exclude_apps = [AppName::atom()], exclude_modules = [{App::atom(), [Module::atom()]}], debug_info = keep | strip, configured_releases = releases(), realized_releases = releases(), include_src = boolean() | undefined, include_erts = boolean() | file:filename(), system_libs = boolean() | file:filename(), upfrom = string() | binary() | undefined, warnings_as_errors = boolean(), src_tests = boolean(), check_for_undefined_functions = boolean(), exref = boolean() | [atom()], overlay = list(), include_nodetool = boolean(), overlay_vars_values = list(), overlay_vars = list(), extended_start_script = boolean(), extended_start_script_hooks = list(), extended_start_script_extensions = list(), generate_start_script = boolean(), include_start_scripts_for = [atom()] | undefined, filter_xref_warning = fun(([{mfa(), mfa()}]) -> [{mfa(), mfa()}]), dev_mode = boolean(), mode = mode() | undefined, is_relx_sasl = boolean()}
add_configured_release(M::t(), Release::rlx_release:t()) -> t()
add_lib_dirs(State::t(), Dirs::[file:name()]) -> t()
add_realized_release(State::t(), Release::rlx_release:t()) -> t()
available_apps(State_t::t()) -> #{atom() => rlx_app_info:t()}
available_apps(M::t(), NewApps::#{atom() => rlx_app_info:t()}) -> t()
base_output_dir(State_t::t()) -> file:name()
base_output_dir(State::t(), Directory::file:filename()) -> t()
check_for_undefined_functions(State_t::t()) -> boolean()
configured_releases(State_t::t()) -> releases()
debug_info(State_t::t()) -> keep | strip
dev_mode(State_t::t()) -> boolean()
exclude_apps(State_t::t()) -> [AppName::atom()]
applications to exclude from the release and remove from .app files
exclude_modules(State_t::t()) -> [{App::atom(), [Module::atom()]}]
modules to be excluded from the release
exref(State_t::t()) -> boolean() | [atom()]
extended_start_script(State_t::t()) -> boolean() | undefined
extended_start_script_extensions(State_t::t()) -> list() | undefined
extended_start_script_hooks(State_t::t()) -> list() | undefined
filter_xref_warning(State_t::t()) -> fun(([{mfa(), mfa()}]) -> [{mfa(), mfa()}])
format(Mod::t()) -> iolist()
format(State_t::t(), Indent::non_neg_integer()) -> iolist()
generate_start_script(State_t::t()) -> boolean() | undefined
get_configured_release(State_t::t(), Name::rlx_release:name(), Vsn::rlx_release:vsn()) -> rlx_release:t()
include_erts(State_t::t()) -> boolean() | file:filename() | undefined
include_erts(S::t(), IncludeErts::boolean() | file:filename()) -> t()
include_nodetool(State_t::t()) -> boolean() | file:filename() | undefined
include_nodetool(S::t(), IncludeNodetool::boolean() | file:filename()) -> t()
include_src(State_t::t()) -> boolean() | undefined
include_start_scripts_for(State_t::t()) -> [atom()] | undefined
is_relx_sasl(State_t) -> any()
lib_dirs(State_t::t()) -> [file:name()]
new() -> any()
overlay(State_t::t()) -> list() | undefined
overlay_vars(State_t) -> any()
overlay_vars(S, OverlayVars) -> any()
overlay_vars_values(State_t) -> any()
overlay_vars_values(S, OverlayVarsValues) -> any()
overrides(State_t::t()) -> [{AppName::atom(), Directory::file:filename()}]
the application overrides for the system
overrides(State::t(), Overrides::[{AppName::atom(), Directory::file:filename()}]) -> t()
the application overrides for the system
realized_releases(State_t::t()) -> releases()
root_dir(State_t::t()) -> file:filename() | undefined
root_dir(State::t(), RootDir::file:filename()) -> t()
src_tests(State_t::t()) -> boolean()
sys_config(State_t::t()) -> file:filename() | false | undefined
sys_config(State::t(), SysConfig::false | undefined | file:filename()) -> t()
sys_config_src(State_t::t()) -> file:filename() | false | undefined
sys_config_src(State::t(), SysConfigSrc::file:filename() | false | undefined) -> t()
system_libs(State_t::t()) -> boolean() | file:filename() | undefined
system_libs(S::t(), SystemLibs::boolean() | file:filename()) -> t()
update_realized_release(M::t(), Release::rlx_release:t()) -> t()
vm_args(State_t::t()) -> file:filename() | false | undefined
vm_args(State::t(), VmArgs::undefined | false | file:filename()) -> t()
vm_args_src(State_t::t()) -> file:filename() | false | undefined
vm_args_src(State::t(), VmArgs::undefined | false | file:filename()) -> t()
warnings_as_errors(State_t::t()) -> boolean()
Generated by EDoc