Change name and documentation of variables FILE_PATHS_DATABASE_DIRECTORY and DIRECTORY_PATHS_DATABASE_DIRECTORY in CONFIGURATIONS in Locatefile

Author: adrianbartyczak

file_management/file_retrieval/locatefile/CONFIGURATIONS

@@ -11,23 +11,21 @@
 #   and is assigned the path to the current directory.
 # 
 
-# Directory of file paths files database
-FILE_PATHS_DATABASE_DIRECTORY="${HERE}/database/file_paths"
+# Database file and directory paths directories 
+DATABASE_FILE_PATHS_DIRECTORY="${HERE}/database/file_paths"
+DATABASE_DIRECTORY_PATHS_DIRECTORY="${HERE}/database/directory_paths"
 
-# Directory of directory paths files database
-DIRECTORY_PATHS_DATABASE_DIRECTORY="${HERE}/database/directory_paths"
-
-# Names of files used in both databases
-#   These file names must match the file names in FILEPATHS. Note: These files
-#   will be searched in in the given order.
+# Names of files used in both database file and directory paths directories
+#   These file names must match the file names in FILEPATHS. Note: They are
+#   searched in the given order.
 DATABASE_FILE_NAMES=('home-paths' 'mount-drive-1-paths' 'mount-drive-2-paths')
 
 # Paths of mounted drives containing files to be located
 #   When a databse file or directory path begins with "{MNTPNT_PATH}/", these
 #   paths will traversed through in place of the "{MNTPNT_PATH}" placeholder
 #   until the file or directory is found. Database paths beginning with
-#   "{MNTPNT_PATH}/" are created when a database file/directory output path
-#   defined in updatedb is prefixed with one of these paths.
+#   "{MNTPNT_PATH}/" are created when a database file path specified in
+#   FILEPATHS is prefixed with one of these paths.
 MOUNTPOINT_PATHS=(
   '/mnt/usb1'
   '/mnt/usb2'

file_management/file_retrieval/locatefile/FILEPATHS

@@ -4,7 +4,7 @@
 #   FILEPATHS
 # 
 # Description:
-#   The file paths to extract to the database
+#   The file paths to output to the database
 # 
 # Usage note:
 #   A file or directory path for a database is specified using the "find_out"
@@ -27,7 +27,7 @@ source "${HERE}/CONFIGURATIONS"
 # FILE PATHS
 
 for dbFileName in "${DATABASE_FILE_NAMES[@]}"; do
-  dest="${FILE_PATHS_DATABASE_DIRECTORY}/${dbFileName}"
+  dest="${DATABASE_FILE_PATHS_DIRECTORY}/${dbFileName}"
 
   case "${dbFileName}" in
     'home-paths')
@@ -64,7 +64,7 @@ done
 # DIRECTORY PATHS
 
 for dbFileName in "${DATABASE_FILE_NAMES[@]}"; do
-  dest="${DIRECTORY_PATHS_DATABASE_DIRECTORY}/${dbFileName}"
+  dest="${DATABASE_DIRECTORY_PATHS_DIRECTORY}/${dbFileName}"
 
   case "${dbFileName}" in
     'home-paths')

file_management/file_retrieval/locatefile/locatefile

@@ -72,9 +72,9 @@ MOUNTPOINT_PATHS=("${mntpntPathsTmp[@]}")
 # ========================================================
 
 if [ "${OPT_RETURN_DIRECTORIES}" = 'true' ]; then
-  CURRENT_DATABASE_DIRECTORY="${DIRECTORY_PATHS_DATABASE_DIRECTORY}"
+  CURRENT_DATABASE_DIRECTORY="${DATABASE_DIRECTORY_PATHS_DIRECTORY}"
 else
-  CURRENT_DATABASE_DIRECTORY="${FILE_PATHS_DATABASE_DIRECTORY}"
+  CURRENT_DATABASE_DIRECTORY="${DATABASE_FILE_PATHS_DIRECTORY}"
 fi
 
 for dbFileName in "${DATABASE_FILE_NAMES[@]}"

file_management/file_retrieval/locatefile/updatedb

@@ -49,16 +49,16 @@ find_out() {
 #   Prepare the database directories
 # ============================================
 
-if [ ! -d "${FILE_PATHS_DATABASE_DIRECTORY}" ]; then
-  mkdir "${FILE_PATHS_DATABASE_DIRECTORY}"
+if [ ! -d "${DATABASE_FILE_PATHS_DIRECTORY}" ]; then
+  mkdir "${DATABASE_FILE_PATHS_DIRECTORY}"
 elif [ "${REMOVE_DATABASE_FILES_BEFORE_UPDATING_DATABASES}" = 'true' ]; then
-  rm -Rf "${FILE_PATHS_DATABASE_DIRECTORY}"/*
+  rm -Rf "${DATABASE_FILE_PATHS_DIRECTORY}"/*
 fi
 
-if [ ! -d "${DIRECTORY_PATHS_DATABASE_DIRECTORY}" ]; then
-  mkdir "${DIRECTORY_PATHS_DATABASE_DIRECTORY}"
+if [ ! -d "${DATABASE_DIRECTORY_PATHS_DIRECTORY}" ]; then
+  mkdir "${DATABASE_DIRECTORY_PATHS_DIRECTORY}"
 elif [ "${REMOVE_DATABASE_FILES_BEFORE_UPDATING_DATABASES}" = 'true' ]; then
-  rm -Rf "${DIRECTORY_PATHS_DATABASE_DIRECTORY}"/*
+  rm -Rf "${DATABASE_DIRECTORY_PATHS_DIRECTORY}"/*
 fi
 
 # ============================================
@@ -71,8 +71,8 @@ source "${HERE}/FILEPATHS"
 #   Process the mountpoint directory paths
 # ============================================
 
-for dbDir in "${FILE_PATHS_DATABASE_DIRECTORY}" \
-    "${DIRECTORY_PATHS_DATABASE_DIRECTORY}"; do
+for dbDir in "${DATABASE_FILE_PATHS_DIRECTORY}" \
+    "${DATABASE_DIRECTORY_PATHS_DIRECTORY}"; do
 
   for dbFileName in "${DATABASE_FILE_NAMES[@]}"; do
     dbFile="${dbDir}/${dbFileName}"