From dc206c4135698fd09c3bf56a2678687e16fe8242 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Dec 06 2010 14:43:25 +0000 Subject: Update documentation manual. --- diff --git a/Manuals/en/Html/Repository/repository_40.html b/Manuals/en/Html/Repository/repository_40.html index 9ab0d6c..361a88a 100644 --- a/Manuals/en/Html/Repository/repository_40.html +++ b/Manuals/en/Html/Repository/repository_40.html @@ -958,32 +958,37 @@ information to use inside `centos-art.sh' script.

The cli_getFilesList function uses LOCATION variable as source location to build a list of files just as specified by regular -expression (REGEX) global variable. +expression (REGEX) global variable. Essentially, what the +cli_getFilesList function does is using find command +to look for files in the location (LOCATION) just as posix-egrep +regular expression (REGEX) specifies.

If LOCATION is not specified when cli_getFilesList function is called, the action value (ACTIONVAL) global variable -is used instead. +is used as location value instead.

By default, if the regular expression (REGEX) global variable is -not redefined after its first definition in cli function, all -files as in `.+' regular expression will be added to the list of -files to process. Otherwise, if you redefine the regular expression -global variable after its first definition in cli and before -calling cli_getFilesList function, the value you specifed is -used instead. -

-

When you need customize the regular expression (REGEX) global -variable value inside a function, do not redefine the global variable. -Instead, make regular expression global variable as `local' to -the function you need a customized regular expression value for. If -you don't redefine the regular expression global variable as local, or -use another name (which is not convenient), you may experiment -undesired concantenation issues that make your regular expression to -be something different from that you expect them to be, specially if -the function you are doing the redefinition is called several times -during the script execution flow. -

- +not redefined after its first definition in the cli function, +all files that match default regular expression value (i.e., +`.+') will be added to the list of files to process. Otherwise, +if you redefine the regular expression global variable after its first +definition in the cli function and before calling +cli_getFilesList function, the value you specifed is used +instead. +

+

When you need to customize the regular expression (REGEX) global +variable value inside a function, do not redefine the global variable +(at least you be absolutly convinced you need to). Instead, set the +regular expression global variable as `local' to the function you +need a customized regular expression value for. If we don't redefine +the regular expression global variable as local to the function, or +use another name for the regular expression variable (which is not +very convenient in order to keep the amount of names to remember low), +you may experiment undesired concantenation issues that make your +regular expression to be something different from that you expect them +to be, specially if the function you are doing the variable +redefinition is called several times during the same script execution. +

Function: cli_getLangCodes [FILTER] diff --git a/Manuals/en/Info/Repository/repository.info.bz2 b/Manuals/en/Info/Repository/repository.info.bz2 index 37e39f7..0f749d6 100644 Binary files a/Manuals/en/Info/Repository/repository.info.bz2 and b/Manuals/en/Info/Repository/repository.info.bz2 differ diff --git a/Manuals/en/Plaintext/Repository/repository.txt b/Manuals/en/Plaintext/Repository/repository.txt index 478cfe3..44e2781 100644 --- a/Manuals/en/Plaintext/Repository/repository.txt +++ b/Manuals/en/Plaintext/Repository/repository.txt @@ -3565,32 +3565,37 @@ global functions you can use inside `centos-art.sh' script. The `cli_getFilesList' function uses LOCATION variable as source location to build a list of files just as specified by regular - expression (REGEX) global variable. + expression (REGEX) global variable. Essentially, what the + `cli_getFilesList' function does is using `find' command to look + for files in the location (LOCATION) just as posix-egrep regular + expression (REGEX) specifies. If LOCATION is not specified when `cli_getFilesList' function is - called, the action value (ACTIONVAL) global variable is used - instead. + called, the action value (ACTIONVAL) global variable is used as + location value instead. By default, if the regular expression (REGEX) global variable is - not redefined after its first definition in `cli' function, all - files as in `.+' regular expression will be added to the list of - files to process. Otherwise, if you redefine the regular expression - global variable after its first definition in `cli' and before - calling `cli_getFilesList' function, the value you specifed is - used instead. - - When you need customize the regular expression (REGEX) global - variable value inside a function, do not redefine the global - variable. Instead, make regular expression global variable as - `local' to the function you need a customized regular expression - value for. If you don't redefine the regular expression global - variable as local, or use another name (which is not convenient), - you may experiment undesired concantenation issues that make your - regular expression to be something different from that you expect - them to be, specially if the function you are doing the - redefinition is called several times during the script execution - flow. + not redefined after its first definition in the `cli' function, + all files that match default regular expression value (i.e., `.+') + will be added to the list of files to process. Otherwise, if you + redefine the regular expression global variable after its first + definition in the `cli' function and before calling + `cli_getFilesList' function, the value you specifed is used + instead. + When you need to customize the regular expression (REGEX) global + variable value inside a function, do not redefine the global + variable (at least you be absolutly convinced you need to). + Instead, set the regular expression global variable as `local' to + the function you need a customized regular expression value for. + If we don't redefine the regular expression global variable as + local to the function, or use another name for the regular + expression variable (which is not very convenient in order to keep + the amount of names to remember low), you may experiment undesired + concantenation issues that make your regular expression to be + something different from that you expect them to be, specially if + the function you are doing the variable redefinition is called + several times during the same script execution. -- Function: cli_getLangCodes [FILTER] Outputs language codes supported by `centos-art.sh' script. @@ -6190,24 +6195,24 @@ Index ***** branches: See 1. (line 390) -Common translation files: See 3.50.2.5. (line 5619) -How to render brands' translation files: See 3.52.3. (line 5923) -How to render fonts' translation files: See 3.54.3. (line 5996) -How to render translation files: See 3.50.3. (line 5789) -Metadata maintainance: See 3.45.2. (line 4763) -Specific translation files: See 3.50.2.6. (line 5644) +Common translation files: See 3.50.2.5. (line 5624) +How to render brands' translation files: See 3.52.3. (line 5928) +How to render fonts' translation files: See 3.54.3. (line 6001) +How to render translation files: See 3.50.3. (line 5794) +Metadata maintainance: See 3.45.2. (line 4768) +Specific translation files: See 3.50.2.6. (line 5649) tags: See 2. (line 393) -Template translation files: See 3.50.2.4. (line 5449) -Translation brands file names: See 3.52.2.1. (line 5880) -Translation configuration scripts: See 3.50.2.8. (line 5678) -Translation entries: See 3.50.2.1. (line 5265) -Translation files: See 3.50.2.3. (line 5381) -Translation markers: See 3.50.2.2. (line 5346) -Translation paths: See 3.50.2.1. (line 5265) +Template translation files: See 3.50.2.4. (line 5454) +Translation brands file names: See 3.52.2.1. (line 5885) +Translation configuration scripts: See 3.50.2.8. (line 5683) +Translation entries: See 3.50.2.1. (line 5270) +Translation files: See 3.50.2.3. (line 5386) +Translation markers: See 3.50.2.2. (line 5351) +Translation paths: See 3.50.2.1. (line 5270) Translation pre-rendering configuration scripts:See 3.50.2.8. - (line 5678) -Translation rendering: See 3.50.2.7. (line 5667) -Translation rendering default functionality: See 3.50.2.9. (line 5764) + (line 5683) +Translation rendering: See 3.50.2.7. (line 5672) +Translation rendering default functionality: See 3.50.2.9. (line 5769) trunk: See 3. (line 396) trunk Identity: See 3.1. (line 399) trunk Identity Brands: See 3.2. (line 819) @@ -6252,31 +6257,31 @@ trunk Manuals: See 3.34. (line 2579) trunk Scripts: See 3.35. (line 2633) trunk Scripts Bash: See 3.36. (line 2657) trunk Scripts Bash Functions: See 3.37. (line 2769) -trunk Scripts Bash Functions Html: See 3.38. (line 3854) -trunk Scripts Bash Functions Locale: See 3.39. (line 3875) -trunk Scripts Bash Functions Manual: See 3.40. (line 3955) -trunk Scripts Bash Functions Path: See 3.41. (line 3976) -trunk Scripts Bash Functions Render: See 3.42. (line 4378) -trunk Scripts Bash Functions Render Config: See 3.43. (line 4399) -trunk Scripts Bash Functions Shell: See 3.44. (line 4577) -trunk Scripts Bash Functions Svg: See 3.45. (line 4745) -trunk Scripts Bash Functions Verify: See 3.46. (line 4933) -trunk Scripts Bash Locale: See 3.47. (line 5149) -trunk Scripts Perl: See 3.48. (line 5178) -trunk Scripts Python: See 3.49. (line 5195) -trunk Translations: See 3.50. (line 5216) -trunk Translations Identity: See 3.51. (line 5818) -trunk Translations Identity Brands: See 3.52. (line 5839) -trunk Translations Identity Brands Tpl: See 3.53. (line 5934) -trunk Translations Identity Fonts: See 3.54. (line 5949) -trunk Translations Identity Models: See 3.55. (line 6012) -trunk Translations Identity Release: See 3.56. (line 6027) -trunk Translations Identity Themes: See 3.57. (line 6042) -trunk Translations Identity Themes Backgrounds:See 3.58. (line 6057) +trunk Scripts Bash Functions Html: See 3.38. (line 3859) +trunk Scripts Bash Functions Locale: See 3.39. (line 3880) +trunk Scripts Bash Functions Manual: See 3.40. (line 3960) +trunk Scripts Bash Functions Path: See 3.41. (line 3981) +trunk Scripts Bash Functions Render: See 3.42. (line 4383) +trunk Scripts Bash Functions Render Config: See 3.43. (line 4404) +trunk Scripts Bash Functions Shell: See 3.44. (line 4582) +trunk Scripts Bash Functions Svg: See 3.45. (line 4750) +trunk Scripts Bash Functions Verify: See 3.46. (line 4938) +trunk Scripts Bash Locale: See 3.47. (line 5154) +trunk Scripts Perl: See 3.48. (line 5183) +trunk Scripts Python: See 3.49. (line 5200) +trunk Translations: See 3.50. (line 5221) +trunk Translations Identity: See 3.51. (line 5823) +trunk Translations Identity Brands: See 3.52. (line 5844) +trunk Translations Identity Brands Tpl: See 3.53. (line 5939) +trunk Translations Identity Fonts: See 3.54. (line 5954) +trunk Translations Identity Models: See 3.55. (line 6017) +trunk Translations Identity Release: See 3.56. (line 6032) +trunk Translations Identity Themes: See 3.57. (line 6047) +trunk Translations Identity Themes Backgrounds:See 3.58. (line 6062) trunk Translations Identity Themes Distro Anaconda Progress:See 3.59. - (line 6078) -trunk Translations Identity Widgets: See 3.60. (line 6171) -Unused definitions: See 3.45.2.1. (line 4870) + (line 6083) +trunk Translations Identity Widgets: See 3.60. (line 6176) +Unused definitions: See 3.45.2.1. (line 4875) List of Figures *************** diff --git a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi index d0c84f9..bb51215 100644 --- a/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi +++ b/Manuals/en/Texinfo/Repository/trunk/Scripts/Bash/Functions.texi @@ -842,31 +842,36 @@ Output list of files to process. The @code{cli_getFilesList} function uses @var{LOCATION} variable as source location to build a list of files just as specified by regular -expression (@var{REGEX}) global variable. +expression (@var{REGEX}) global variable. Essentially, what the +@code{cli_getFilesList} function does is using @command{find} command +to look for files in the location (@var{LOCATION}) just as posix-egrep +regular expression (@var{REGEX}) specifies. If @var{LOCATION} is not specified when @code{cli_getFilesList} function is called, the action value (@var{ACTIONVAL}) global variable -is used instead. +is used as location value instead. By default, if the regular expression (@var{REGEX}) global variable is -not redefined after its first definition in @code{cli} function, all -files as in @samp{.+} regular expression will be added to the list of -files to process. Otherwise, if you redefine the regular expression -global variable after its first definition in @code{cli} and before -calling @code{cli_getFilesList} function, the value you specifed is -used instead. - -When you need customize the regular expression (@var{REGEX}) global -variable value inside a function, do not redefine the global variable. -Instead, make regular expression global variable as @samp{local} to -the function you need a customized regular expression value for. If -you don't redefine the regular expression global variable as local, or -use another name (which is not convenient), you may experiment -undesired concantenation issues that make your regular expression to -be something different from that you expect them to be, specially if -the function you are doing the redefinition is called several times -during the script execution flow. - +not redefined after its first definition in the @code{cli} function, +all files that match default regular expression value (i.e., +@samp{.+}) will be added to the list of files to process. Otherwise, +if you redefine the regular expression global variable after its first +definition in the @code{cli} function and before calling +@code{cli_getFilesList} function, the value you specifed is used +instead. + +When you need to customize the regular expression (@var{REGEX}) global +variable value inside a function, do not redefine the global variable +(at least you be absolutly convinced you need to). Instead, set the +regular expression global variable as @samp{local} to the function you +need a customized regular expression value for. If we don't redefine +the regular expression global variable as local to the function, or +use another name for the regular expression variable (which is not +very convenient in order to keep the amount of names to remember low), +you may experiment undesired concantenation issues that make your +regular expression to be something different from that you expect them +to be, specially if the function you are doing the variable +redefinition is called several times during the same script execution. @end defun @defun cli_getLangCodes [FILTER]