Module rlx_release

This module represents a release and its metadata and is used to manipulate the release metadata.

Copyright © (C) 2012 Erlware, LLC.

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

Description

This module represents a release and its metadata and is used to manipulate the release metadata.

Data Types

application_spec()

application_spec() = {name(), vsn()} | {name(), vsn(), type() | incl_apps()} | {name(), vsn(), type(), incl_apps()}

incl_apps()

incl_apps() = [name()]

name()

name() = atom()

parsed_goal()

parsed_goal() = #{name := name(), vsn => vsn() | undefined, type => type(), included_applications => incl_apps()}

parsed_goals()

parsed_goals() = [{name(), parsed_goal()}]

release_spec()

release_spec() = {release, {string(), vsn()}, {erts, vsn()}, [application_spec()]}

t()

t() = #release_t{name = atom(), vsn = string(), erts = undefined | string(), goals = parsed_goals() | undefined, realized = boolean(), app_specs = [application_spec()], applications = [rlx_app_info:t()], relfile = undefined | string(), config = any()}

type()

type() = permanent | transient | temporary | load | none

vsn()

vsn() = string()

Function Index

app_specs/1
applications/1
canonical_name/1produce the canonical name <name>-<vsn> for this release.
config/1
config/2
erts/1
erts/2
format/1
format_error/1
goals/1
goals/2
metadata/1
name/1
new/2
no_dot_erlang_metadata/1
parse_goals/1
parsed_goals/2
realize/2
relfile/2
start_clean_metadata/1
vsn/1

Function Details

app_specs/1

app_specs(Release_t) -> any()

applications/1

applications(Release_t) -> any()

canonical_name/1

canonical_name(Release_t::t()) -> string()

produce the canonical name <name>-<vsn> for this release

config/1

config(Release_t::t()) -> list()

config/2

config(Release::t(), Config::list()) -> t()

erts/1

erts(Release_t::t()) -> vsn()

erts/2

erts(Release::t(), Vsn::vsn()) -> t()

format/1

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

format_error/1

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

goals/1

goals(Release_t::t()) -> parsed_goals()

goals/2

goals(Release::t(), ConfigGoals::[relx:goal()]) -> t()

metadata/1

metadata(Release_t::t()) -> release_spec()

name/1

name(Release_t::t()) -> atom()

new/2

new(ReleaseName::atom(), ReleaseVsn::string()) -> t()

no_dot_erlang_metadata/1

no_dot_erlang_metadata(Release_t::t()) -> release_spec()

parse_goals/1

parse_goals(ConfigGoals::[application_spec()]) -> parsed_goals()

parsed_goals/2

parsed_goals(Release::t(), ParsedGoals::parsed_goals()) -> t()

realize/2

realize(Rel::t(), Pkgs0::[rlx_app_info:t()]) -> {ok, t()}

relfile/2

relfile(Release::t(), Relfile::file:name()) -> t()

start_clean_metadata/1

start_clean_metadata(Release_t::t()) -> release_spec()

vsn/1

vsn(Release_t::t()) -> string()


Generated by EDoc