ca2691 Update `scripts-functions.texinfo' inside `tcar-fs' documentation

Authored and Committed by areguera 13 years ago
    Update `scripts-functions.texinfo' inside `tcar-fs' documentation
    manual.
    
    
        
Manuals/Tcar-fs/en_US/Trunk/scripts-functions.texinfo CHANGED
@@ -2,9 +2,11 @@
2
2
@section @file{trunk/Scripts/Functions}
3
3
@cindex Trunk scripts functions
4
4
5
- The @file{trunk/Scripts/Functions} directory exists to organize
6
- task-specific functionalities related to the @command{centos-art.sh}
7
- script.
5
+ The @file{trunk/Scripts/Functions} directory exists to organize common
6
+ and spectic functionalities related to the @command{centos-art.sh}
7
+ script. Common functionalities are loaded once the
8
+ @command{centos-art.sh} script is executed and made available for
9
+ sepecific functionalities to reuse.
8
10
9
11
The @file{trunk/Scripts/Functions} directory and all files inside it
10
12
are under version control.
@@ -12,11 +14,56 @@ are under version control.
12
14
Content rendition inside `trunk/Scripts/Functions' directory is not
13
15
supported.
14
16
15
- Inside @file{trunk/Scripts/Functions} directory, functionalities are
16
- organized in the following directories:
17
+ Inside @file{trunk/Scripts/Functions} directory, specific
18
+ functionalities are organized in the following directories:
17
19
18
20
@c -- <[centos-art(SeeAlso)
19
21
@itemize
20
22
@item @ref{Trunk Scripts Functions Prepare}
21
23
@end itemize
22
24
@c -- ]>
25
+
26
+ Inside @file{trunk/Scripts/Functions} directory, common
27
+ functionalities are stored in files prefixed with the @samp{cli}
28
+ string as described below:
29
+
30
+ @defun cli "$@@"
31
+ The @code{cli} functionality initializes the command-line interface
32
+ (cli) of @command{centos-art.sh} script. This function evaluates the
33
+ first argument provided to @command{centos-art.sh} script and call the
34
+ specific functionality that respondes to it. The @code{cli} function
35
+ is directly called from @file{centos-art.sh} itself once global
36
+ variables are defined, working copy verification performed, common
37
+ functionalities exported into the execution environment, and signals
38
+ trapped. The @code{cli} function receives all positional parameters
39
+ passed to @command{centos-art.sh} as argument.
40
+
41
+ The @code{cli} function creates the a new environment inside that one
42
+ created by @command{centos-art.sh} script execution. Variables defined
43
+ herein will be avaialble to all specific functionalities and common
44
+ functionalities used inside specific functionalities.
45
+
46
+ @defvar FUNCNAM
47
+ The @var{FUNCNAM} variable stores the function name passed as first
48
+ argument to @command{centos-art.sh} script using the file convenction
49
+ specified by @code{cli_getRepoName} function.
50
+ @end defvar
51
+
52
+ @defvar FUNCDIR
53
+ The @var{FUNCDIR} variable stores the absolute path of directory
54
+ holding @command{centos-art.sh} script functions, both common and
55
+ specific.
56
+ @end defvar
57
+
58
+ @defvar FUNCDIRNAM
59
+ ...
60
+ @end defvar
61
+
62
+ @defvar FUNCSCRIPT
63
+ ...
64
+ @end defvar
65
+
66
+ @defvar ARGUMENTS
67
+ ...
68
+ @end defvar
69
+ @end defun