Module rlx_state

Provides state management services for the relx tool.

Copyright © (C) 2012 Erlware, LLC.

Authors: Eric Merritt (ericbmerritt@gmail.com).

Description

Provides state management services for the relx tool. Generally, those things that are fixed have a direct api. Those things that are mutable have a more mutable api.

Data Types

action()

action() = atom()

caller()

caller() = command_line | api

cmd_args()

cmd_args() = proplists:proplist()

releases()

releases() = ec_dictionary:dictionary({rlx_release:name(), rlx_release:vsn()}, rlx_release:t())

t()

abstract datatype: t()

Function Index

actions/1the actions targeted for this system.
add_configured_release/2
add_lib_dirs/2
add_provider/2
add_realized_release/2
append_hook/3
available_apps/1
available_apps/2
base_output_dir/1
base_output_dir/2
caller/1
caller/2
cli_args/1
cli_args/2
config_file/1
config_file/2
configured_releases/1
debug_info/1
debug_info/2
default_configured_release/1
default_configured_release/3
dev_mode/1
dev_mode/2
exclude_apps/1
exclude_apps/2the application overrides for the system.
exclude_modules/1
exclude_modules/2modules to be excluded from the release.
format/1
format/2
get/2
get/3
get_configured_release/3
get_realized_release/3
goals/1
goals/2
hooks/2
include_src/1
include_src/2
lib_dirs/1
log/1get the current log state for the system.
new/2
new/3
output_dir/1
overrides/1the application overrides for the system.
overrides/2the application overrides for the system.
prepend_hook/3
providers/1
providers/2
put/3
realized_releases/1
realized_releases/2
root_dir/1
root_dir/2
skip_apps/1
skip_apps/2the application overrides for the system.
sys_config/1
sys_config/2
sys_config_src/1
sys_config_src/2
update_realized_release/2
upfrom/1
upfrom/2
vm_args/1
vm_args/2
vm_args_src/1
vm_args_src/2
warnings_as_errors/1
warnings_as_errors/2

Function Details

actions/1

actions(State_t::t()) -> [action()]

the actions targeted for this system

add_configured_release/2

add_configured_release(M::t(), Release::rlx_release:t()) -> t()

add_lib_dirs/2

add_lib_dirs(State::t(), Dirs::[file:name()]) -> t()

add_provider/2

add_provider(M::t(), Provider::providers:t()) -> t()

add_realized_release/2

add_realized_release(State::t(), Release::rlx_release:t()) -> t()

append_hook/3

append_hook(State, Target, Hook) -> any()

available_apps/1

available_apps(State_t::t()) -> [rlx_app_info:t()]

available_apps/2

available_apps(M::t(), NewApps::[rlx_app_info:t()]) -> t()

base_output_dir/1

base_output_dir(State_t::t()) -> file:name()

base_output_dir/2

base_output_dir(State::t(), Directory::file:filename()) -> t()

caller/1

caller(State_t::t()) -> caller()

caller/2

caller(S::t(), Caller::caller()) -> t()

cli_args/1

cli_args(State_t::t()) -> proplists:proplist()

cli_args/2

cli_args(State::t(), CliArgs::proplists:proplist()) -> t()

config_file/1

config_file(State_t::t()) -> file:filename() | proplists:proplist() | undefined

config_file/2

config_file(State::t(), ConfigFiles::file:filename() | proplists:proplist() | undefined) -> t()

configured_releases/1

configured_releases(State_t::t()) -> releases()

debug_info/1

debug_info(State_t::t()) -> keep | strip

debug_info/2

debug_info(State::t(), DebugInfo::keep | strip) -> t()

default_configured_release/1

default_configured_release(State_t::t()) -> {rlx_release:name() | undefined, rlx_release:vsn() | undefined} | default

default_configured_release/3

default_configured_release(M::t(), Name::rlx_release:name(), Vsn::rlx_release:vsn()) -> t()

dev_mode/1

dev_mode(State_t::t()) -> boolean()

dev_mode/2

dev_mode(S::t(), DevMode::boolean()) -> t()

exclude_apps/1

exclude_apps(State_t::t()) -> [AppName::atom()]

exclude_apps/2

exclude_apps(State::t(), SkipApps::[AppName::atom()]) -> t()

the application overrides for the system

exclude_modules/1

exclude_modules(State_t::t()) -> [{App::atom(), [Module::atom()]}]

exclude_modules/2

exclude_modules(State::t(), SkipModules::[{App::atom(), [Module::atom()]}]) -> t()

modules to be excluded from the release

format/1

format(Mod::t()) -> iolist()

format/2

format(State_t::t(), Indent::non_neg_integer()) -> iolist()

get/2

get(State_t::t(), Key::atom()) -> term()

get/3

get(State_t::t(), Key::atom(), DefaultValue::term()) -> term()

get_configured_release/3

get_configured_release(State_t::t(), Name::rlx_release:name(), Vsn::rlx_release:vsn()) -> rlx_release:t()

get_realized_release/3

get_realized_release(State_t::t(), Name::rlx_release:name(), Vsn::rlx_release:vsn()) -> rlx_release:t()

goals/1

goals(State_t::t()) -> [rlx_depsolver:constraint()]

goals/2

goals(State::t(), Goals::[rlx_depsolver:constraint()]) -> t()

hooks/2

hooks(State::t(), Target::atom()) -> {[providers:t()], [providers:t()]}

include_src/1

include_src(State_t::t()) -> boolean()

include_src/2

include_src(S::t(), IncludeSrc::boolean()) -> t()

lib_dirs/1

lib_dirs(State_t::t()) -> [file:name()]

log/1

log(State_t::t()) -> ec_cmd_log:t()

get the current log state for the system

new/2

new(Config::string(), Targets::undefined | [atom()]) -> t() | relx:error()

new/3

new(Config::string(), CommandLineConfig::proplists:proplist(), Targets::undefined | [atom()]) -> t() | relx:error()

output_dir/1

output_dir(State::t()) -> file:name()

overrides/1

overrides(State_t::t()) -> [{AppName::atom(), Directory::file:filename()}]

the application overrides for the system

overrides/2

overrides(State::t(), Overrides::[{AppName::atom(), Directory::file:filename()}]) -> t()

the application overrides for the system

prepend_hook/3

prepend_hook(State, Target, Hook) -> any()

providers/1

providers(State_t::t()) -> [providers:t()]

providers/2

providers(M::t(), NewProviders::[providers:t()]) -> t()

put/3

put(M::t(), Key::atom(), Value::term()) -> t()

realized_releases/1

realized_releases(State_t::t()) -> releases()

realized_releases/2

realized_releases(State::t(), Releases::releases()) -> t()

root_dir/1

root_dir(State_t::t()) -> file:filename() | undefined

root_dir/2

root_dir(State::t(), RootDir::file:filename()) -> t()

skip_apps/1

skip_apps(State_t::t()) -> [AppName::atom()]

skip_apps/2

skip_apps(State::t(), SkipApps::[AppName::atom()]) -> t()

the application overrides for the system

sys_config/1

sys_config(State_t::t()) -> file:filename() | false | undefined

sys_config/2

sys_config(State::t(), SysConfig::false | file:filename()) -> t()

sys_config_src/1

sys_config_src(State_t::t()) -> file:filename() | undefined

sys_config_src/2

sys_config_src(State::t(), SysConfigSrc::file:filename() | undefined) -> t()

update_realized_release/2

update_realized_release(M::t(), Release::rlx_release:t()) -> t()

upfrom/1

upfrom(State_t::t()) -> string() | binary() | undefined

upfrom/2

upfrom(State::t(), UpFrom::string() | binary() | undefined) -> t()

vm_args/1

vm_args(State_t::t()) -> file:filename() | false | undefined

vm_args/2

vm_args(State::t(), VmArgs::undefined | false | file:filename()) -> t()

vm_args_src/1

vm_args_src(State_t::t()) -> file:filename() | undefined

vm_args_src/2

vm_args_src(State::t(), VmArgs::undefined | file:filename()) -> t()

warnings_as_errors/1

warnings_as_errors(State_t::t()) -> boolean()

warnings_as_errors/2

warnings_as_errors(State::t(), WarningsAsErrors::boolean()) -> t()


Generated by EDoc, May 1 2024, 06:25:03.