Blame Manuals/Tcar-fs/en_US/Trunk/scripts-functions.texinfo

8e11d8
@node Trunk Scripts Functions
8e11d8
@section @file{trunk/Scripts/Functions}
8e11d8
@cindex Trunk scripts functions
8e11d8
ca2691
The @file{trunk/Scripts/Functions} directory exists to organize common
ca2691
and spectic functionalities related to the @command{centos-art.sh}
ca2691
script. Common functionalities are loaded once the
ca2691
@command{centos-art.sh} script is executed and made available for
ca2691
sepecific functionalities to reuse.
8e11d8
8e11d8
The @file{trunk/Scripts/Functions} directory and all files inside it
8e11d8
are under version control.
8e11d8
8e11d8
Content rendition inside `trunk/Scripts/Functions' directory is not
8e11d8
supported.
8e11d8
ca2691
Inside @file{trunk/Scripts/Functions} directory, specific
ca2691
functionalities are organized in the following directories:
8e11d8
8e11d8
@c -- <[centos-art(SeeAlso)
8e11d8
@itemize
8e11d8
@item @ref{Trunk Scripts Functions Prepare}
8e11d8
@end itemize
8e11d8
@c -- ]>
ca2691
ca2691
Inside @file{trunk/Scripts/Functions} directory, common
ca2691
functionalities are stored in files prefixed with the @samp{cli}
ca2691
string as described below:
ca2691
ca2691
@defun cli "$@@"
ca2691
The @code{cli} functionality initializes the command-line interface
ca2691
(cli) of @command{centos-art.sh} script. This function evaluates the
ca2691
first argument provided to @command{centos-art.sh} script and call the
ca2691
specific functionality that respondes to it. The @code{cli} function
ca2691
is directly called from @file{centos-art.sh} itself once global
ca2691
variables are defined, working copy verification performed, common
ca2691
functionalities exported into the execution environment, and signals
ca2691
trapped. The @code{cli} function receives all positional parameters
ca2691
passed to @command{centos-art.sh} as argument.
ca2691
ca2691
The @code{cli} function creates the a new environment inside that one
ca2691
created by @command{centos-art.sh} script execution. Variables defined
ca2691
herein will be avaialble to all specific functionalities and common
ca2691
functionalities used inside specific functionalities.
ca2691
ca2691
@defvar FUNCNAM
ca2691
The @var{FUNCNAM} variable stores the function name passed as first
ca2691
argument to @command{centos-art.sh} script using the file convenction
ca2691
specified by @code{cli_getRepoName} function.
ca2691
@end defvar
ca2691
ca2691
@defvar FUNCDIR
ca2691
The @var{FUNCDIR} variable stores the absolute path of directory
ca2691
holding @command{centos-art.sh} script functions, both common and
ca2691
specific.
ca2691
@end defvar
ca2691
ca2691
@defvar FUNCDIRNAM
ca2691
...
ca2691
@end defvar
ca2691
ca2691
@defvar FUNCSCRIPT
ca2691
...
ca2691
@end defvar
ca2691
ca2691
@defvar ARGUMENTS
ca2691
...
ca2691
@end defvar
ca2691
@end defun