Copyright © (C) 2012 Erlware, LLC.
Authors: Eric Merritt (ericbmerritt@gmail.com).
error() = {error, {Module::module(), Reason::term()}}
goal() = string() | binary() | rlx_depsolver:constraint()
do/2 | provides an API to run the Relx process from erlang applications. |
do/7 | provides an API to run the Relx process from erlang applications. |
do/8 | provides an API to run the Relx process from erlang applications. |
do/9 | provides an API to run the Relx process from erlang applications. |
format_error/1 | |
main/1 | |
main/2 | |
opt_spec_list/0 |
do(Opts::proplists:proplist(), NonOpts::[string()]) -> ok | error() | {ok, rlx_state:t()}
Opts:
- A proplist of options. There are good defaults for each of these entries, so any or all may be omitted. Individual options may be:
{relname, RelName}
{relvsn, RelVsn}
{goals, Goals}
{lib_dirs, LibDirs}
{lib_dir, LibDir}
{output_dir, OutputDir}
{root_dir, RootDir}
{config, Config}
{log_level, LogLevel}
{overrides, Overrides}
{override, Override}
provides an API to run the Relx process from erlang applications
do(RelName::atom(), RelVsn::string(), Goals::[goal()], LibDirs::[file:name()], LogLevel::ec_cmd_log:log_level(), OutputDir::[file:name()], Config::file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}
RelName: - The release name to build (maybe undefined
)
RelVsn: - The release version to build (maybe undefined
)
Goals: - The release goals for the system in depsolver or Relx goal
format
LibDirs: - The library dirs that should be used for the system
OutputDir: - The directory where the release should be built to
provides an API to run the Relx process from erlang applications
do(RootDir::file:name(), RelName::atom(), RelVsn::string(), Goals::[goal()], LibDirs::[file:name()], LogLevel::ec_cmd_log:log_level(), OutputDir::[file:name()], Configs::file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}
RootDir: - The root directory for the project
RelName: - The release name to build (maybe undefined
)
RelVsn: - The release version to build (maybe undefined
)
Goals: - The release goals for the system in depsolver or Relx goal
format
LibDirs: - The library dirs that should be used for the system
OutputDir: - The directory where the release should be built to
Configs: - The list of config files for the system
provides an API to run the Relx process from erlang applications
do(RootDir::file:name(), RelName::atom(), RelVsn::string(), Goals::[goal()], LibDirs::[file:name()], LogLevel::ec_cmd_log:log_level(), OutputDir::[file:name()], Overrides::[{atom(), file:name()}], Config::file:name() | undefined) -> ok | error() | {ok, rlx_state:t()}
RootDir: - The root directory for the system
RelName: - The release name to build (maybe undefined
)
RelVsn: - The release version to build (maybe undefined
)
Goals: - The release goals for the system in depsolver or Relx goal
format
LibDirs: - The library dirs that should be used for the system
OutputDir: - The directory where the release should be built to
Overrides: - A list of overrides for the system
provides an API to run the Relx process from erlang applications
format_error(Reason::term()) -> string()
main(Args::[string()]) -> ok | error() | {ok, rlx_state:t()}
main(ApiOptions, Args) -> any()
opt_spec_list() -> [getopt:option_spec()]
Generated by EDoc, Jun 11 2024, 05:32:01.