From ec989d82d2cccbf5714b0620bd103de9a057305b Mon Sep 17 00:00:00 2001 From: Tuncer Ayaz Date: Sun, 25 Jul 2010 16:02:07 +0200 Subject: Correct a couple of reltool documentation errors Fix typos and other errors. --- lib/reltool/doc/src/reltool.xml | 76 ++++++++++++++++++++--------------------- 1 file changed, 38 insertions(+), 38 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 0c2b7d2a2b..598594145a 100644 --- a/lib/reltool/doc/src/reltool.xml +++ b/lib/reltool/doc/src/reltool.xml @@ -48,8 +48,8 @@ root_dir is the root directory of the analysed system and it defaults to the system executing reltool. Applications may also be located outside root_dir. lib_dirs - defines additional library directories where applications - additional may reside and it defaults to the the directories + defines library directories where additional applications + may reside and it defaults to the directories listed by the operating system environment variable ERL_LIBS. See the module code for more info. Finally single modules and entire applications may be read from @@ -58,10 +58,10 @@

Some configuration parameters control the behavior of Reltool on system (sys) level. Others provide control on application (app) level and yet others are on module - (mod) level. Module level parameters overrides application - level parameters and application level parameters overrides system + (mod) level. Module level parameters override application + level parameters and application level parameters override system level parameters. Escript escript level parameters - overrides system level parameters.

+ override system level parameters.

The following top level options are supported:

@@ -74,7 +74,7 @@ a name of a file containing a sys tuple.

- trap_exit> + trap_exit

This option controls the error handling behavior of reltool. By default the window processes traps @@ -123,10 +123,10 @@ defaults to all which means that if an application is included (either explicitly or implicitly) all modules in that application will be included. This implies that both modules - that exists on the ebin directory of the application, + that exist in the ebin directory of the application, as well as modules that are named in the app file will be included. If the parameter is set to ebin, both - modules on the ebin directory and derived modules are + modules in the ebin directory and derived modules are included. If the parameter is set to app, both modules in the app file and derived modules are included. derived means that only modules that are used by other @@ -138,13 +138,13 @@

This parameter controls the application and escript inclusion policy. It defaults to derived which means - that the applications that not have any explicit + that the applications that do 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 + escripts that do not have any explicit incl_cond setting will be included. exclude implies that all - applications and escripts) that that not have any explicit + applications and escripts) that do not have any explicit incl_cond setting will be excluded.

@@ -158,7 +158,7 @@ rel

Release specific configuration. Each release maps to a - rel, script and boot file. See the + rel, script and boot file. See the module systools for more info about the details. Each release has a name, a version and a set of applications with a few release specific parameters such as type and included @@ -168,7 +168,7 @@ relocatable

This parameter controls whether the erl executable - in the target system automatically should determine where it + in the target system should automatically 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 @@ -182,7 +182,7 @@

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 + files than you are interested in 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 @@ -224,12 +224,12 @@ incl_sys_filters

This parameter normally contains a list of regular - expressions that controls which files in the system that + expressions that controls which files in the system should be included. Each file in the target system must match at least one of the listed regular expressions in order to be included. Further the files may not match any filter in excl_sys_filters in order to be included. Which - application files that should be included are controlled with + application files should be included is controlled with the parameters incl_app_filters and excl_app_filters. This parameter defaults to [".*"].

@@ -238,8 +238,8 @@ excl_sys_filters

This parameter normally contains a list of regular - expressions that controls which files in the system that not - should be included in the target system. In order to be + expressions that controls which files in the system should + not be included in the target system. In order to be included, a file must match some filter in incl_sys_filters but not any filter in excl_sys_filters. This parameter defaults to @@ -260,7 +260,7 @@

This parameter normally contains a list of regular expressions that controls which application specific files - that not should be included in the target system. In order to + should not be included in the target system. In order to be included, a file must match some filter in incl_app_filters but not any filter in excl_app_filters. This parameter defaults to @@ -271,8 +271,8 @@

This parameter normally contains a list of regular expressions that controls which top level directories in an - application that should be included in an archive file (as - opposed of beeing included as a regular directory outside the + application should be included in an archive file (as + opposed to being included as a regular directory outside the archive). Each top directory in the application must match at least one of the listed regular expressions in order to be included. Further the files may not match any filter in @@ -284,7 +284,7 @@

This parameter normally contains a list of regular expressions that controls which top level directories in an - application that not should be included in an archive file. In + application should not be included in an archive file. In order to be included in the application archive, a top directory must match some filter in incl_archive_filters but not any filter in excl_archive_filters. This @@ -295,15 +295,15 @@

This parameter contains a list of options that are given to zip:create/3 when application specific files are - packaged into an archive. All options are not supported. The - most useful options in this context, are the ones that - controls which types of files that should be compressed. This + packaged into an archive. Only a subset of the options are + supported. The most useful options in this context are the ones + that control which types of files should be compressed. This parameter defaults to [].

-

On application (escript) level,the following options are +

On application (escript) level, the following options are supported:

@@ -314,7 +314,7 @@
-

On application (app) level,the following options are +

On application (app) level, the following options are supported:

@@ -322,8 +322,8 @@

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.

+ controls which version of the application will be chosen. If it + is omitted, the latest version will be chosen.

mod @@ -380,7 +380,7 @@
-

On module (mod) level,the following options are +

On module (mod) level, the following options are supported:

@@ -391,9 +391,9 @@ 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.

+ exclude implies that the module is not included. + derived implies that the module is included if it is used + by any other included module.

debug_info @@ -546,12 +546,12 @@ target_spec() = [target_spec()] files are by default copied to the target system. The releases directory contains generated rel, script, and boot files. The lib directory - contains the applications. Which applications that are included + contains the applications. Which applications are included and if they should be customized (archived, stripped from debug info etc.) is specified with various configuration parameters. The files in the bin directory are copied from the erts-vsn/bin directory, but only those files - that was originally included in bin directory of the + that were originally included in the bin directory of the source system.

If the configuration parameter relocatable was set to @@ -584,10 +584,10 @@ target_spec() = [target_spec()] Reason = reason()

Get reltool configuration. Normally, only the explicit - configuration parameters with values that differs from their + configuration parameters with values that differ from their defaults are interesting. But the builtin default values can be returned by setting InclDefaults to true. The - derived configuration can be return by setting + derived configuration can be returned by setting InclDerived to true.

@@ -705,7 +705,7 @@ target_spec() = [target_spec()] Reason = reason()

Start a server process with options. The server process - identity can be given as argument to several other functions in the + identity can be given as an argument to several other functions in the API.

-- cgit v1.2.3