diff --git a/Automation/centos-art.conf.sh b/Automation/centos-art.conf.sh index 4b12a3e..3bfd66d 100755 --- a/Automation/centos-art.conf.sh +++ b/Automation/centos-art.conf.sh @@ -5,8 +5,7 @@ # values to centos-art.sh script. # # Written by: -# * Alain Reguera Delgado , 2013 -# Key fingerprint = D67D 0F82 4CBD 90BC 6421 DF28 7CCE 757C 17CA 3951 +# * Alain Reguera Delgado , 2009-2013 # # Copyright (C) 2013 The CentOS Project # @@ -26,138 +25,116 @@ # ###################################################################### -# -------------------------------------------------------------------- +###################################################################### # Script's identity configuration variables. -# -------------------------------------------------------------------- -# +###################################################################### + # Set the script name. -# declare -x TCAR_SCRIPT_NAME="centos-art.sh" -# + # Set the script command name. -# declare -x TCAR_SCRIPT_COMMAND="centos-art" -# -# Set the script version. -# -declare -x TCAR_SCRIPT_VERSION='0.5' -# + +# Set the script version. You can use this number as pattern +# to identify the relation between the centos-artwork repository +# and the script. Both repository and script version must be the same. +# This way we can say that specific functionalities inside the script +# will work as expected when run over the repository directory structure. +declare -x TCAR_SCRIPT_VERSION='0.4' + # Set the script modules directory. -# declare -x TCAR_SCRIPT_MODULES_BASEDIR=${TCAR_SCRIPT_BASEDIR}/Modules -# + # Set the script temporal directory. -# declare -xr TCAR_SCRIPT_TEMPDIR=$(mktemp -p /tmp -d ${TCAR_SCRIPT_NAME}-XXXXXX) -# -------------------------------------------------------------------- +###################################################################### # Internationalization configuration variables and functions. -# -------------------------------------------------------------------- -# +###################################################################### + # Set the script language information using the LC format. This format # shows both language and country information (e.g., `es_ES'). -# declare -xr TCAR_SCRIPT_LANG_LC=$(echo ${LANG} | cut -d'.' -f1) -# + # Set the script language information using the LL format. This format # shows only the language information (e.g., `es'). -# declare -xr TCAR_SCRIPT_LANG_LL=$(echo ${TCAR_SCRIPT_LANG_LC} | cut -d'_' -f1) -# + # Set the script language information using the CC format. This format # shows only the country information (e.g., `ES'). -# declare -xr TCAR_SCRIPT_LANG_CC=$(echo ${TCAR_SCRIPT_LANG_LC} | cut -d'_' -f2) -# + # Set function environments required by GNU gettext system. -# . gettext.sh -# + # Set the script text domain. This information is used by gettext # system to retrieve translated strings from machine object (MO) files # with this name. This variable is reset each time a new module is # loaded, so the correct files can be used. -# declare -xr TEXTDOMAIN="${TCAR_SCRIPT_NAME}" -# + # Set the script text domain directory. This information is used by # gettext system to know where the machine objects are stored in. This # variable is reset each time a new module is loaded, so the correct # files can be used. -# declare -xr TEXTDOMAINDIR=${TCAR_SCRIPT_BASEDIR}/Locales -# -------------------------------------------------------------------- +###################################################################### # Module-specific configuration variables. -# -------------------------------------------------------------------- -# +###################################################################### + # This variable is used in different function environments to pass # positional parameters from one environment to another using local # definitions. -# declare -x TCAR_ARGUMENTS='' -# -# Set absolute path to documentation source format. This is the file -# we'll use as input to `a2x' command to produce documentation in -# different formats. -# -declare -x TCAR_MANUAL_FILE=${TCAR_SCRIPT_BASEDIR}/${TCAR_SCRIPT_NAME}.asciidoc -# + # Set absolute path to documentation search path. This is the location # where final documentation formats (e.g., man pages) will be saved # in. -# declare -x TCAR_MANUAL_SEARCHPATH=${TCAR_SCRIPT_BASEDIR}/Manuals -# + +# Set absolute path to documentation source format. This is the file +# we'll use as input to `a2x' command to produce documentation in +# different formats. +declare -x TCAR_MANUAL_FILE=${TCAR_MANUAL_SEARCHPATH}/${TCAR_SCRIPT_NAME}.asciidoc + # Set command used to read man pages. Include in this command the # sarch path where final man pages live in. -# declare -x TCAR_MANUAL_READER="/usr/bin/man -M ${TCAR_MANUAL_SEARCHPATH}" -# -------------------------------------------------------------------- +###################################################################### # User-related configuration variables. -# -------------------------------------------------------------------- -# +###################################################################### + # Set file path to your preferred text editor. The editor you specify # will be use when you need to write commit messages and anything that # requires text edition. -# declare -x TCAR_USER_EDITOR=/usr/bin/vim -# + # Set user-specific configuration file used by centos-art.sh script to # determine where to retrieve user-specific configuration values. # User-specific configuration files let you customize the way # centos-art.sh behaves in a multi-user environment. This variable # must be read-only. -# declare -xr TCAR_USER_CONFIG=${HOME}/.centos-art.conf.sh -# -------------------------------------------------------------------- +###################################################################### # Flag-related configuration variables. -# -------------------------------------------------------------------- -# +###################################################################### + # Set filter flag (-f|--filter). This flag is mainly used to reduce # the number of files to process and is interpreted as egrep-posix # regular expression. By default, when this flag is not provided, all # paths in the working copy will match, except files inside hidden # directories like `.svn' and `.git' that will be omitted. -# declare -x TCAR_FLAG_FILTER='[[:alnum:]_/-]+' -# + # Set verbosity flag (-q|--quiet). This flag controls whether # centos-art.sh script prints messages or not. By default, all # messages are suppressed except those directed to standard error. -# declare -x TCAR_FLAG_QUIET='false' -# + # Set affirmative flag (-y|--yes). This flag controls whether # centos-art.sh script does or does not pass confirmation request # points. By default, it doesn't. -# declare -x TCAR_FLAG_YES='false' -# -# Set synchronization flag (-z|--synchronize). This flag controls -# whether version control system is triggered or not after realizing -# changes to source files under version control. -# -declare -x TCAR_FLAG_SYNCHRONIZE='false'