Blame Scripts/Documentation/Reference/Tcar/tcar_checkRepoDirSource.asciidoc

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