Blame Manuals/tcar_checkRepoDirSource.sh.asciidoc

Alain Reguera Delgado e54180
tcar_checkRepoDirSource.sh(1)
Alain Reguera Delgado e54180
=============================
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
== Name
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
tcar_checkRepoDirSource - Standardize the working copy's absolute path
Alain Reguera Delgado e54180
construction.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
== Synopsis
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
tcar_checkRepoDirSource "LOCATION"
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
== Description
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
The *tcar_checkRepoDirSource* function standardizes the path
Alain Reguera Delgado e54180
construction to directories inside it the working copy, using absolute
Alain Reguera Delgado e54180
paths.  This function transforms relative paths passed as non-option
Alain Reguera Delgado e54180
arguments to *centos-art.sh* script command-line into absolute paths
Alain Reguera Delgado e54180
inside the working copy and verifies whether they really exist as
Alain Reguera Delgado e54180
directories inside the working copy or not. If the path provided
Alain Reguera Delgado e54180
doesn't exist as directory inside the working copy, the script will
Alain Reguera Delgado e54180
finish its execution immediately with an error message. Otherwise, if
Alain Reguera Delgado e54180
the directory exists, the variable +TCAR_ARGUMENTS+ is redefined with
Alain Reguera Delgado e54180
the related absolute path for further use.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Use the *tcar_checkRepoDirSource* function whenever you need to be
Alain Reguera Delgado e54180
sure that non-option arguments passed to *centos-art.sh* script
Alain Reguera Delgado e54180
command-line will always point to directories inside the working copy.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
== Bugs
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
See https://centos.org.cu/bugs/
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
== Authors
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
The *tcar_checkRepoDirSource* function has received contributions from
Alain Reguera Delgado e54180
the following people:
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
- Alain Reguera Delgado <al@centos.org.cu>, =COPYRIGHT_YEAR_LIST=
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
== License
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
Copyright (C) =COPYRIGHT_YEAR_LIST= =COPYRIGHT_HOLDER=
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
This program is free software; you can redistribute it and/or modify
Alain Reguera Delgado e54180
it under the terms of the GNU General Public License as published by
Alain Reguera Delgado e54180
the Free Software Foundation; either version 2 of the License, or (at
Alain Reguera Delgado e54180
your option) any later version.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
This program is distributed in the hope that it will be useful, but
Alain Reguera Delgado e54180
WITHOUT ANY WARRANTY; without even the implied warranty of
Alain Reguera Delgado e54180
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Alain Reguera Delgado e54180
General Public License for more details.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
You should have received a copy of the GNU General Public License
Alain Reguera Delgado e54180
along with this program; if not, write to the Free Software
Alain Reguera Delgado e54180
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Alain Reguera Delgado e54180
Alain Reguera Delgado e54180
// vim: set syntax=asciidoc: