From 067785da7c85152aa8d2436935e77fef3efaaa2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kan=20Mattsson?= Date: Thu, 18 Feb 2010 17:06:58 +0100 Subject: Created escript for simplified usage from makefiles --- lib/reltool/doc/src/reltool.xml | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) (limited to 'lib/reltool/doc/src/reltool.xml') diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index 9786928ae8..15beec52d6 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -477,7 +477,9 @@ mod_name() = atom() profile() = development | embedded | standalone re_regexp() = string() reason() = string() -regexps() = [re_regexp()] | {add, [re_regexp()]} | {del, [re_regexp()]} +regexps() = [re_regexp()] + | {add, [re_regexp()]} + | {del, [re_regexp()]} rel_file() = term() rel_name() = string() rel_vsn() = string() @@ -487,7 +489,19 @@ script_file() = term() server() = server_pid() | options() server_pid() = pid() target_dir() = file() -window_pid() = pid()]]> +window_pid() = pid() +base_dir() = dir() +base_file() = file() +top_dir() = file() +top_file() = file() +target_spec() = [target_spec()] + | {create_dir, base_dir(), [target_spec()]} + | {create_dir, base_dir(), top_dir(), [target_spec()]} + | {archive, base_file(), [archive_opt()], [target_spec()]} + | {copy_file, base_file()} + | {copy_file, base_file(), top_file()} + | {write_file, base_file(), iolist()} + | {strip_beam_file, base_file()}]]> -- cgit v1.2.3 From 512b1a258c083021f199e6cad2da479e7fdfd6dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kan=20Mattsson?= Date: Tue, 9 Mar 2010 18:46:31 +0100 Subject: Add function to return status about the configuration It is called reltool:get_status/1. The API functions in reltool that may take PidOrOptions as input and actually gets Options does now print out the warnings. --- lib/reltool/doc/src/reltool.xml | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'lib/reltool/doc/src/reltool.xml') diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index 15beec52d6..24683b9302 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -617,6 +617,17 @@ target_spec() = [target_spec()] more details.

+ + get_status(Server) -> {ok, [Warning]} | {error, Reason} + Get contents of a release file + + Server = server() + Warning = string() + Reason = reason() + +

Get status about the configuration

 + + get_server(WindowPid) -> {ok, ServerPid} | {error, Reason} Start server process with options -- cgit v1.2.3 From bc5807db3a4bb72395da7d32f4bee4a4678e8bfe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kan=20Mattsson?= Date: Fri, 26 Mar 2010 16:57:42 +0100 Subject: Removed spurious CDATA in documentation --- lib/reltool/doc/src/reltool.xml | 70 ++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 35 deletions(-) (limited to 'lib/reltool/doc/src/reltool.xml') diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index 24683b9302..a46323b1f2 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -67,14 +67,14 @@ - + config

This is the main option and it controls the configuration of reltool. It can either be a sys tuple or a name of a file containing a sys tuple.

 - + trap_exit>

This option controls the error handling behavior of reltool. By default the window processes traps @@ -82,7 +82,7 @@ trap_exit to false.

 - + wx_debug

This option controls the debug level of wx. As its name indicates it is only useful for debugging. See @@ -97,27 +97,27 @@ - + erts

Erts specific configuration. See application level options below.

 - + escript

Escript specific configuration. An escript has a mandatory file name and escript level options that are described below.

 - + app

Application specific configuration. An application has a mandatory name and application level options that are described below.

 - + mod_cond

This parameter controls the module inclusion policy. It defaults to all which means that if an application is @@ -134,7 +134,7 @@ system level is used as default for all applications.

 - + incl_cond

This parameter controls the application and escript inclusion policy. It defaults to derived which means @@ -148,14 +148,14 @@ incl_cond setting will be excluded.

 - + boot_rel

A target system may have several releases but the one given as boot_rel will be used as default when the system is booting up.

 - + rel

Release specific configuration. Each release maps to a rel, script and boot file. See the @@ -165,7 +165,7 @@ applications.

 - + relocatable

This parameter controls whether the erl executable in the target system automatically should determine where it @@ -177,7 +177,7 @@ re-installation. The default is true.

 - + profile

The creation of the specification for a target system is performed in two steps. In the first step a complete @@ -196,7 +196,7 @@ incl_app_filters and excl_app_filters.

 - + app_file

This parameter controls the default handling of the app files when a target system is generated. It @@ -213,7 +213,7 @@ and strip.

 - + debug_info

The debug_info parameter controls whether the debug information in the beam file should be kept (keep) or @@ -221,7 +221,7 @@ system.

 - + incl_sys_filters

This parameter normally contains a list of regular expressions that controls which files in the system that @@ -235,7 +235,7 @@ [".*"].

 - + excl_sys_filters

This parameter normally contains a list of regular expressions that controls which files in the system that not @@ -245,7 +245,7 @@ excl_sys_filters. This parameter defaults to [].

 - + incl_app_filters

This parameter normally contains a list of regular expressions that controls which application specific files @@ -256,7 +256,7 @@ parameter defaults to [".*"].

 - + excl_app_filters

This parameter normally contains a list of regular expressions that controls which application specific files @@ -267,7 +267,7 @@ [].

 - + incl_archive_filters

This parameter normally contains a list of regular expressions that controls which top level directories in an @@ -280,7 +280,7 @@ parameter defaults to [".*"].

 - + excl_archive_filters

This parameter normally contains a list of regular expressions that controls which top level directories in an @@ -291,7 +291,7 @@ parameter defaults to ["^include$","^priv$"].

 - + archive_opts

This parameter contains a list of options that are given to zip:create/3 when application specific files are @@ -307,7 +307,7 @@ supported:

- + incl_cond

The value of this parameter overrides the parameter with the same name on system level.

@@ -318,62 +318,62 @@ supported:

- + vsn

The version of the application. In an installed system there may exist several versions of an application. The vsn parameter controls which version of the application that will be choosen. If it is omitted, the latest version will be choosen.

 - + mod

Module specific configuration. A module has a mandatory name and module level options that are described below.

 - + mod_cond

The value of this parameter overrides the parameter with the same name on system level.

 - + incl_cond

The value of this parameter overrides the parameter with the same name on system level.

 - + app_file

The value of this parameter overrides the parameter with the same name on system level.

 - + debug_info

The value of this parameter overrides the parameter with the same name on system level.

 - + incl_app_filters

The value of this parameter overrides the parameter with the same name on system level.

 - + excl_app_filters

The value of this parameter overrides the parameter with the same name on system level.

 - + incl_archive_filters

The value of this parameter overrides the parameter with the same name on system level.

 - + excl_archive_filters

The value of this parameter overrides the parameter with the same name on system level.

 - + archive_opts

The value of this parameter overrides the parameter with the same name on system level.

@@ -384,7 +384,7 @@ supported:

- + incl_cond

This parameter controls whether the module is included or not. By default the mod_incl parameter on application and system level @@ -395,7 +395,7 @@ derived implies that the is included if any included uses the module.

 - + debug_info

The value of this parameter overrides the parameter with the same name on application level.

-- cgit v1.2.3 From e57e7f332fcf9ea26a7f7536b18a24181b680463 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5kan=20Mattsson?= Date: Thu, 22 Apr 2010 09:30:12 +0200 Subject: Make some cleanups --- lib/reltool/doc/src/reltool.xml | 88 ++++++++++++++++++++--------------------- 1 file changed, 44 insertions(+), 44 deletions(-) (limited to 'lib/reltool/doc/src/reltool.xml') diff --git a/lib/reltool/doc/src/reltool.xml b/lib/reltool/doc/src/reltool.xml index a46323b1f2..0c2b7d2a2b 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -136,16 +136,16 @@ incl_cond -

This parameter controls the application and escript - inclusion policy. It defaults to derived which means - that the applications that not have any explicit - incl_cond setting, will only be included if any other - (explicitly or implicitly included) application uses it. The - value include implies that all applications and - escripts that that not have any explicit incl_cond - setting will be included. exclude implies that all - applications and escripts) that that not have any explicit - incl_cond setting will be excluded.

+

This parameter controls the application and escript + inclusion policy. It defaults to derived which means + that the applications that not have any explicit + incl_cond setting, will only be included if any other + (explicitly or implicitly included) application uses it. The + value include implies that all applications and + escripts that that not have any explicit incl_cond + setting will be included. exclude implies that all + applications and escripts) that that not have any explicit + incl_cond setting will be excluded.

 boot_rel @@ -167,33 +167,33 @@ relocatable -

This parameter controls whether the erl executable - in the target system automatically should determine where it - is installed or if it should use a hardcoded path to the - installation. In the latter case the target system must be - installed with reltool:install/2 before it can be - used. If the system is relocatable, the file tree containing - the target system can be moved to another location without - re-installation. The default is true.

+

This parameter controls whether the erl executable + in the target system automatically should determine where it + is installed or if it should use a hardcoded path to the + installation. In the latter case the target system must be + installed with reltool:install/2 before it can be + used. If the system is relocatable, the file tree containing + the target system can be moved to another location without + re-installation. The default is true.

 profile -

The creation of the specification for a target system is - performed in two steps. In the first step a complete - specification is generated. It will likely contain much more - files than you are interested in your customized target - system. In the second step the specification will be filtered - according to your filters. There you have the ability to - specify filters per application as well as system wide - filters. You can also select a profile for your - system. Depending on the profile, different default - filters will be used. There are three different profiles to - choose from: development, embedded and - standalone. development is default. The - parameters that are affected by the profile are: - incl_sys_filters, excl_sys_filters, - incl_app_filters and excl_app_filters.

+

The creation of the specification for a target system is + performed in two steps. In the first step a complete + specification is generated. It will likely contain much more + files than you are interested in your customized target + system. In the second step the specification will be filtered + according to your filters. There you have the ability to + specify filters per application as well as system wide + filters. You can also select a profile for your + system. Depending on the profile, different default + filters will be used. There are three different profiles to + choose from: development, embedded and + standalone. development is default. The + parameters that are affected by the profile are: + incl_sys_filters, excl_sys_filters, + incl_app_filters and excl_app_filters.

 app_file @@ -386,14 +386,14 @@ incl_cond -

This parameter controls whether the module is included or not. By - default the mod_incl parameter on application and system level - will be used to control whether the module is included or not. The - value of incl_cond overrides the module inclusion policy. - include implies that the module is included, while - exclude implies that the module not is included. - derived implies that the is included if any included uses the - module.

+

This parameter controls whether the module is included or not. By + default the mod_incl parameter on application and system level + will be used to control whether the module is included or not. The + value of incl_cond overrides the module inclusion policy. + include implies that the module is included, while + exclude implies that the module not is included. + derived implies that the is included if any included uses the + module.

 debug_info @@ -479,7 +479,7 @@ re_regexp() = string() reason() = string() regexps() = [re_regexp()] | {add, [re_regexp()]} - | {del, [re_regexp()]} + | {del, [re_regexp()]} rel_file() = term() rel_name() = string() rel_vsn() = string() @@ -511,9 +511,9 @@ target_spec() = [target_spec()] create_target(Server, TargetDir) -> ok | {error, Reason} Create a target system - Server = server() + Server = server() TargetDir = target_dir() - Reason = reason() + Reason = reason()

Create a target system. Gives the same result as {ok,TargetSpec}=reltool:get_target_spec(Server) and -- cgit v1.2.3