Module relx

Data Types
Function Index
Function Details

Copyright © (C) 2012 Erlware, LLC.

Authors: Tristan Sloughter (t@crashfast.com), Eric Merritt (ericbmerritt@gmail.com).

Data Types

error()

error() = {error, {Module::module(), Reason::term()}}

goal()

goal() = rlx_release:name() | {rlx_release:name(), rlx_release:vsn() | rlx_release:type()} | {rlx_release:name(), rlx_release:vsn(), rlx_release:type() | rlx_release:incl_apps()} | {rlx_release:name(), rlx_release:vsn(), rlx_release:type(), rlx_release:incl_apps()}

release()

release() = #{name := atom(), vsn := string(), goals := [goal()], relfile_path := file:filename_all() | undefined}

Function Index

build_release/2
build_release/3
build_relup/4
build_tar/2
build_tar/3
format_error/1
release/3

Function Details

build_release/2

build_release(Release, Config) -> {ok, rlx_state:t()} | {error, term()}

Release = atom() | {atom(), string()} | release()
Config = rlx_config:t()

build_release/3

build_release(Release, Apps, State) -> {ok, rlx_state:t()} | {error, term()}

Release = atom() | {atom(), string()} | release() | undefined
Apps = #{atom() => rlx_app_info:t()}
State = rlx_state:t()

build_relup/4

build_relup(RelName::rlx_release:name(), ToVsn::rlx_release:vsn(), UpFromVsn::rlx_release:vsn(), Config::rlx_config:t() | rlx_state:t()) -> {ok, rlx_state:t()} | {error, term()}

build_tar/2

build_tar(Release, Config) -> {ok, rlx_release:t()}

Release = atom() | {atom(), string()} | release() | undefined
Config = rlx_config:t()

build_tar/3

build_tar(Release, Apps, State) -> {ok, rlx_release:t()}

Release = atom() | {atom(), string()} | release() | undefined
Apps = #{atom() => rlx_app_info:t()}
State = rlx_state:t()

format_error/1

format_error(Reason::term()) -> string()

release/3

release(Name::rlx_release:name(), Vsn::rlx_release:vsn(), Goals::[goal()]) -> release()

Generated by EDoc