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_usage.xml | 70 +++++++++++++++++------------------ 1 file changed, 35 insertions(+), 35 deletions(-) (limited to 'lib/reltool/doc/src/reltool_usage.xml') 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