Copyright © (C) 2012 Erlware, LLC.
Authors: Eric Merritt (ericbmerritt@gmail.com).
action() = atom()
caller() = command_line | api
cmd_args() = proplists:proplist()
releases() = ec_dictionary:dictionary({rlx_release:name(), rlx_release:vsn()}, rlx_release:t())
abstract datatype: t()
the actions targeted for this system
add_configured_release(M::t(), Release::rlx_release:t()) -> t()
add_lib_dirs(State::t(), Dirs::[file:name()]) -> t()
add_provider(M::t(), Provider::providers:t()) -> t()
add_realized_release(State::t(), Release::rlx_release:t()) -> t()
append_hook(State, Target, Hook) -> any()
available_apps(State_t::t()) -> [rlx_app_info:t()]
available_apps(M::t(), NewApps::[rlx_app_info:t()]) -> t()
base_output_dir(State_t::t()) -> file:name()
base_output_dir(State::t(), Directory::file:filename()) -> t()
cli_args(State_t::t()) -> proplists:proplist()
cli_args(State::t(), CliArgs::proplists:proplist()) -> t()
config_file(State_t::t()) -> file:filename() | proplists:proplist() | undefined
config_file(State::t(), ConfigFiles::file:filename() | proplists:proplist() | undefined) -> t()
configured_releases(State_t::t()) -> releases()
debug_info(State_t::t()) -> keep | strip
default_configured_release(State_t::t()) -> {rlx_release:name() | undefined, rlx_release:vsn() | undefined} | default
default_configured_release(M::t(), Name::rlx_release:name(), Vsn::rlx_release:vsn()) -> t()
dev_mode(State_t::t()) -> boolean()
exclude_apps(State_t::t()) -> [AppName::atom()]
the application overrides for the system
exclude_modules(State_t::t()) -> [{App::atom(), [Module::atom()]}]
modules to be excluded from the release
format(Mod::t()) -> iolist()
format(State_t::t(), Indent::non_neg_integer()) -> iolist()
get(State_t::t(), Key::atom()) -> term()
get(State_t::t(), Key::atom(), DefaultValue::term()) -> term()
get_configured_release(State_t::t(), Name::rlx_release:name(), Vsn::rlx_release:vsn()) -> rlx_release:t()
get_realized_release(State_t::t(), Name::rlx_release:name(), Vsn::rlx_release:vsn()) -> rlx_release:t()
goals(State_t::t()) -> [rlx_depsolver:constraint()]
goals(State::t(), Goals::[rlx_depsolver:constraint()]) -> t()
hooks(State::t(), Target::atom()) -> {[providers:t()], [providers:t()]}
include_src(State_t::t()) -> boolean()
lib_dirs(State_t::t()) -> [file:name()]
log(State_t::t()) -> ec_cmd_log:t()
get the current log state for the system
new(Config::string(), Targets::undefined | [atom()]) -> t() | relx:error()
new(Config::string(), CommandLineConfig::proplists:proplist(), Targets::undefined | [atom()]) -> t() | relx:error()
output_dir(State::t()) -> file:name()
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
prepend_hook(State, Target, Hook) -> any()
providers(State_t::t()) -> [providers:t()]
providers(M::t(), NewProviders::[providers:t()]) -> t()
realized_releases(State_t::t()) -> releases()
realized_releases(State::t(), Releases::releases()) -> t()
root_dir(State_t::t()) -> file:filename() | undefined
root_dir(State::t(), RootDir::file:filename()) -> t()
skip_apps(State_t::t()) -> [AppName::atom()]
the application overrides for the system
sys_config(State_t::t()) -> file:filename() | false | undefined
sys_config(State::t(), SysConfig::false | file:filename()) -> t()
sys_config_src(State_t::t()) -> file:filename() | undefined
sys_config_src(State::t(), SysConfigSrc::file:filename() | undefined) -> t()
update_realized_release(M::t(), Release::rlx_release:t()) -> t()
upfrom(State_t::t()) -> string() | binary() | undefined
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() | undefined
vm_args_src(State::t(), VmArgs::undefined | file:filename()) -> t()
warnings_as_errors(State_t::t()) -> boolean()
Generated by EDoc, Jun 11 2024, 05:22:44.