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

app_name()

app_name() = atom()

app_type()

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

app_vsn()

app_vsn() = string()

application_constraint()

application_constraint() = rlx_depsolver:raw_constraint() | string() | binary()

application_goal()

application_goal() = application_constraint() | {application_constraint(), app_type() | incl_apps()} | {application_constraint(), app_type(), incl_apps() | void}

application_spec()

application_spec() = {app_name(), app_vsn()} | {app_name(), app_vsn(), app_type() | incl_apps()} | {app_name(), app_vsn(), app_type(), incl_apps()}

incl_apps()

incl_apps() = [app_name()]

name()

name() = atom()

t()

abstract datatype: t()

vsn()

vsn() = string()

Function Index

application_details/1this gives the rlx_app_info objects representing the applications in this release.
application_details/2this is only expected to be called by a process building a new release from an existing rel file.
applications/1this gives the application specs for the release.
canonical_name/1produce the canonical name (<name>-<vsn>) for this release.
config/1
config/2
erts/1
erts/2
format/1
format/2
format_error/1
goals/1
goals/2
metadata/1
name/1
new/2
new/3
no_dot_erlang_metadata/1
realize/3
realized/1
relfile/1
relfile/2
start_clean_metadata/1
vsn/1

Function Details

application_details/1

application_details(Release_t::t()) -> [rlx_app_info:t()]

this gives the rlx_app_info objects representing the applications in this release. These should only be populated by the 'realize' call in this module or by reading an existing rel file.

application_details/2

application_details(Release::t(), AppDetail::[rlx_app_info:t()]) -> t()

this is only expected to be called by a process building a new release from an existing rel file.

applications/1

applications(Release_t::t()) -> [application_spec()]

this gives the application specs for the release. This can only be populated by the 'realize' call in this module.

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()) -> app_vsn()

erts/2

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

format/1

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

format/2

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

format_error/1

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

goals/1

goals(Release_t::t()) -> [application_goal()]

goals/2

goals(Release::t(), Goals0::[application_goal()]) -> {ok, t()} | relx:error()

metadata/1

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

name/1

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

new/2

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

new/3

new(ReleaseName::atom(), ReleaseVsn::string(), Relfile::undefined | file:name()) -> t()

no_dot_erlang_metadata/1

no_dot_erlang_metadata(T::t()) -> term()

realize/3

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

realized/1

realized(Release_t::t()) -> boolean()

relfile/1

relfile(Release_t::t()) -> file:name() | undefined

relfile/2

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

start_clean_metadata/1

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

vsn/1

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


Generated by EDoc, Jun 11 2024, 05:27:21.