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 +++++++++++++++++------------------ lib/reltool/doc/src/reltool_usage.xml | 70 ++++++++++++++++---------------- 2 files changed, 73 insertions(+), 73 deletions(-) (limited to 'lib/reltool/doc/src') 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.

 diff --git a/lib/reltool/doc/src/reltool_usage.xml b/lib/reltool/doc/src/reltool_usage.xml index 885828d1f0..0a053a014e 100644 --- a/lib/reltool/doc/src/reltool_usage.xml +++ b/lib/reltool/doc/src/reltool_usage.xml @@ -44,7 +44,7 @@
System window

The system window is started with the function - reltool:start/1. At startup the tool will process the all + reltool:start/1. At startup the tool will process all beam files and app files in order to find out dependencies between applications and their modules. Once all this information has been derived, it will be possible to explore the tool.

@@ -67,29 +67,29 @@
Libraries

On the library page it is possible to control which sources - that the tool will use. The page is organized as a tree which + the tool will use. The page is organized as a tree which can be expanded and collapsed by clicking on the little symbol in the beginning of the expandable/collapsible lines.

The Root directory can be edited by selecting the line where the path of the root directory is displayed and - clicking with the right mouse button. Choose edit in the menu - that pops up.

+ clicking the right mouse button. Choose edit in the menu + that pops up.

Library directories can be added, edited or deleted. This is done by selecting the line where the path to a library - directory is displayed and clicking with the right mouse + directory is displayed and clicking the right mouse button. Choose add, edit or delete in the menu that pops up. New library directories can also be added by selecting the - line Library directories and clicking with the right + line Library directories and clicking the right mouse button. Choose add in the menu that pops up.

Escript files can be added, edited or deleted. This is done by selecting the line where the path to an escript file is - displayed and clicking with the right mouse button. Choose + displayed and clicking the right mouse button. Choose add, edit or delete in the menu that pops up. New escripts can also be added by selecting the line Escript files and - clicking with the right mouse button. Choose add in the menu + clicking the right mouse button. Choose add in the menu that pops up.

When libraries and escripts are expanded, the names of @@ -102,7 +102,7 @@

On the system settings page it is possible to control some global settings that are used as defaults for all applications. Set the Application inclusion policy to - include to include all applications that not are + include to include all applications that are not explicitly excluded. See incl_cond (application inclusion) and mod_cond (module inclusion) in the reference manual for the module reltool for more @@ -131,14 +131,14 @@

The symbols in front of the application names are intended to describe the status of the application. There are error - symbols and warning symbols that means that there are - something that needs attention. The tick symbol means that the + and warning symbols to signalize that there is + something which needs attention. The tick symbol means that the application is included or derived and no problem has been detected. The cross symbol means that the application is excluded or available and no problem has been detected. Applications with error symbols are listed first in - each category, then comes the warnings and the normal ones - (ticks and crosses) are found at the end.

+ each category and are followed by the warnings and the + normal ones (ticks and crosses) at the end.

Double click on an application to launch its application window.

@@ -175,8 +175,8 @@

Save configuration - Saves the current - configuration to file. Normally, only the explictit - configuration parameters with values that differs from their + configuration to file. Normally, only the explicit + configuration parameters with values that differ from their defaults are saved. But the configuration with or without default values and with or without derived values may also be saved.

@@ -204,21 +204,21 @@

It is possible to perform some limited manipulations of the graph. Nodes can be moved, selected, locked or deleted. Move a single node or the entire graph by moving the mouse while the - left mouse button is pressed. A node is can be locked into a fix + left mouse button is pressed. A node can be locked into a fix position by holding down the shift button when the left mouse button is released. Select several nodes by moving the mouse - while the control key and the left mouse button i + while the control key and the left mouse button are pressed. Selected nodes can be locked, unlocked or deleted by - klicking on a suitable button.

+ clicking on a suitable button.

The algorithm that is used to draw a graph with as few crossed links as possible is called force graph. A force graph - consists of nodes and directed link between nodes. Each node is + consists of nodes and directed links between nodes. Each node is associated with a repulsive force that pushes nodes away from each other. This force can be adjusted with the left slider or with the mouse wheel. Each link is associated with an attractive - force that pulls the nodes nearer each other. This force can be - adjusted with the right slider. If this force becomes to strong, + force that pulls the nodes nearer to each other. This force can be + adjusted with the right slider. If this force becomes too strong, the graph will be unstable. The third parameter that can be adjusted is the length of the links. It is adjusted with the middle slider.

@@ -256,7 +256,7 @@

Select version of the application in the Source selection policy part of the page. By default the latest version of the application is selected, but it is possible to override this by - explicitly select another version.

+ explicitly selecting another version.

By default the Application inclusion policy on system level is used for all applications. Set the value to @@ -272,10 +272,10 @@ want actually used modules to be included. Set it to app if you, besides derived modules, also want the modules listed in the app file to be included. Set it to ebin if you, besides - derived modules, also want the modules that exists as beam files - on the ebin directory to be included. Set it to all if you + derived modules, also want the modules that exist as beam files + in the ebin directory to be included. Set it to all if you want all modules to be included, that is the union of modules - found on the ebin directory and listed in the app file.

+ found in the ebin directory and listed in the app file.

The application settings page is rather incomplete.

@@ -299,16 +299,16 @@ undone.

The symbols in front of the module names are intended to - describe the status of the module. There are error symbols - and warning symbols that means that there are something that needs + describe the status of the module. There are error and + and warning symbols to signalize that there is something that needs attention. The tick symbol means that the module is included or derived and no problem has been detected. The cross symbol means that the module is excluded or available and no problem has been detected. Modules with error symbols are listed - first in each category, then comes the warnings and the normal - ones (ticks and crosses) are found at the end.

+ first in each category and are followed by warnings and the + normal ones (ticks and crosses) at the end.

-

Double click on an module to launch its module window.

+

Double click on a module to launch its module window.

@@ -323,7 +323,7 @@ app file. If the application includes other applications, these are listed under Included. These applications are listed in the included_applications part of the app - file. If the application uses modules other applications, these + file. If the application uses other applications, these are listed under Uses.

Double click on an application name to launch an application window.

@@ -336,7 +336,7 @@

There are two categories of modules on the Module dependencies page. If the module is used by other modules, these are listed under Modules used by others. If the - module uses modules other modules, these are listed under Used + module uses other modules, these are listed under Used modules.

Double click on an module name to launch a module window.

@@ -365,8 +365,8 @@

There are two categories of modules on the Dependencies page. If the module is used by other modules, these are listed - under Modules used by others. If the module uses modules - other modules, these are listed under Used modules.

+ under Modules used by others. If the module uses other + modules, these are listed under Used modules.

Double click on an module name to launch a module window.

@@ -378,7 +378,7 @@

On the Code page the Erlang source code is displayed. It is possible to search forwards and backwards for text in the module. Enter a regular expression in the Find field and - press enter. It is also possible to goto a certain line on the + press enter. It is also possible to go to a certain line in the module. The Back button can be used to go back to the previous position.

-- cgit v1.2.3