update R-overlay.conf config files

2 files changed, 126 insertions, 53 deletions

diff --git a/R-overlay.conf b/R-overlay.conf
index da8da1f..29d7b33 100644
--- a/R-overlay.conf
+++ b/R-overlay.conf
@@ -1,68 +1,139 @@
-# R overlay -- config file for testing/running without installation
+# R-overlay.conf
+#  This is roverlay's main config file
+#
 
-SHELL = /bin/sh
+# --- Required Configuration ---
 
-ADDITIONS_DIR = files
-HOOK          = files/hooks/mux.sh
-HOOK_RESTRICT = "* -user"
-ECLASS        = files/eclass/R-packages.eclass
+# this is the directory where per-repo package directories will be
+#  created
+DISTFILES="workdir/distfiles"
 
-CACHEDIR      = workdir/cache
-DISTFILES     = distfiles-root
-OVERLAY_DIR   = workdir/overlay
-#TMPDIR        = workdir/tmp
+# this is the directory of the overlay to be created/maintained
+OVERLAY_DIR="workdir/overlay"
 
-STATS_DB      = workdir/cache/stats.rrd
-TEMPLATE_ROOT = files/mako_templates
+# this is the directory where hard/symbolic links to all package files
+#  will be created (during Manifest file creation)
+DISTDIR="workdir/mirror"
 
-LICENSE_MAP = config/license.map
+LOG_FILE="workdir/log/roverlay.log"
 
-DISTDIR       = workdir/distroot
-# try hard links first, then fall back to symbolic ones
-DISTDIR_STRATEGY = "hardlink symlink"
+# directory for cache data
+CACHEDIR="workdir/cache"
 
-# distdir verification is normally not needed
-DISTDIR_VERIFY = no
+# portage directory
+#  used to scan for valid licenses
+PORTDIR="/usr/portage"
 
-# write description data from R packages to a directory
-DESCRIPTION_DIR = desc-files
 
-# = logging =
+# --- Logging Configuration (optional) ---
 
-LOG_LEVEL = INFO
+# global log level, choices are DEBUG, INFO, WARN, WARNING, ERROR,
+#  CRITICAL.
+LOG_LEVEL="INFO"
 
-LOG_CONSOLE = yes
-LOG_LEVEL_CONSOLE = WARNING
-
-LOG_FILE       = log/roverlay.log
-LOG_LEVEL_FILE = WARN
+LOG_LEVEL_CONSOLE="WARNING"
+LOG_LEVEL_FILE="WARNING"
 
 # this enables per-run log files
-LOG_FILE_ROTATE = yes
+LOG_FILE_ROTATE="yes"
+
 # number of backup log files to keep
-LOG_FILE_ROTATE_COUNT = 5
+#  Defaults to "3".
+#LOG_FILE_ROTATE_COUNT="5"
+
+# file where unresolved dependency strings will be written to
+LOG_FILE_UNRESOLVABLE="workdir/log/dep_unresolvable.log"
 
-# log unresolvable dependencies into an extra file
-LOG_FILE_UNRESOLVABLE = log/dep_unresolvable.log
 
-# = misc =
+# --- Other Configuration Options ---
 
-# bandwidth limit for rsync (in kilobytes per second)
-# RSYNC_BWLIMIT = 12000
+# directory containing ebuilds and ebuild patches
+ADDITIONS_DIR="files"
 
-# = extra config files =
+# file for renaming USE_EXPAND flags
+#USE_EXPAND_RENAME="files/use_expand.rename"
 
-# PACKAGE_RULES lists the per-package files that control package processing
-#  PACKAGE_RULES ::= "<file|dir>[ <file|dir>]"
+# USE_EXPAND flag description file
+#USE_EXPAND_DESC="files/use_expand.desc"
+
+# list of dependency rule files
+# using the default dependency rule files
+# Can be extended by appending other directories/files
+SIMPLE_RULES_FILE="config/simple-deprules.d"
+
+# list of package rule files/dirs
 PACKAGE_RULES="config/package_rules"
 
-# SIMPLE_RULES_FILE lists the rule files for dependency resolution
-#  SIMPLE_RULES_FILE ::= "<file>[ <file>]"
-SIMPLE_RULES_FILE = "config/simple-deprules.d"
+# stats database file
+#  Defaults to "" (disable persistent stats).
+STATS_DB="workdir/cache/stats.db"
+
+# script that is run on certain events, e.g. overlay_success
+EVENT_HOOK="files/hooks/mux.sh"
+
+# hook (shell) config file
+EVENT_HOOK_RC="config/hookrc"
+
+# mask for running hooks
+# Note:
+#  setting -user is highly recommended when running roverlay as root
+#  Defaults to "*" (allow all).
+EVENT_HOOK_RESTRICT="-* db_written overlay_success user"
+
+# directories with templates for status reports
+TEMPLATE_ROOT="files/mako_templates"
+
+# dictionary file for translating license strings
+LICENSE_MAP="config/license.map"
+
+# Not required but ebuilds won't be functional without the eclass
+OVERLAY_ECLASS="files/eclass/R-packages.eclass"
+
+# default category for created ebuilds
+#  Defaults to "sci-R".
+#OVERLAY_CATEGORY="sci-R"
+
+# using the default repo list
+REPO_CONFIG="config/repo.list"
+
+# using the default field definition file
+FIELD_DEFINITION="config/description_fields.conf"
+
+# if set: write description files (read from tarballs) into this
+#  directory. Leave blank / comment out to disable.
+# Note that this slows overlay creation down.
+#DESCRIPTION_DIR="workdir/cache/desc-files"
+
+# using the default distdir strategy
+#  try hard links first, then fall back to symbolic ones
+DISTDIR_STRATEGY="hardlink symlink"
+
+# check integrity of distdir files on startup
+#  usually not needed
+#DISTDIR_VERIFY="no"
+
+# distmap compression format (none, bzip2 or gzip)
+#  Defaults to "bzip2".
+#DISTMAP_COMPRESSION="bzip2"
+
+# distmap file
+#  Defaults to "<CACHEDIR>/distmap.db".
+#DISTMAP_FILE=""
+
+# try to read licenses from PORTDIR/licenses
+#  Defaults to "yes".
+#USE_PORTAGE_LICENSES="no"
+
+# create a licenses file after reading portage licenses
+#  Defaults to "yes".
+#CREATE_LICENSES_FILE="no"
 
-# the repo config file, this can also be a whitespace-separated list of files
-#  REPO_CONFIG ::= "<file>[ <file>]"
-REPO_CONFIG = config/repo.list
+# forbid/allow syncing with remotes
+#  Defaults to "no".
+#NOSYNC="yes"
 
-# the field definition file that controls how R packages are read
-FIELD_DEFINITION = config/description_fields.conf
+# Manifest file creation
+#  Available choices are 'next' (internal, fast)
+#  and 'ebuild' (using ebuild(1), slow, but failsafe).
+#  Defaults to "next".
+#MANIFEST_IMPLEMENTATION="ebuild"
diff --git a/config/R-overlay.conf.install b/config/R-overlay.conf.install
index e30382a..7e84d3f 100644
--- a/config/R-overlay.conf.install
+++ b/config/R-overlay.conf.install
@@ -38,8 +38,12 @@ PORTDIR="/usr/portage"
 #LOG_FILE_ROTATE="yes"
 
 # number of backup log files to keep
+#  Defaults to "3".
 #LOG_FILE_ROTATE_COUNT="5"
 
+# file where unresolved dependency strings will be written to
+#LOG_FILE_UNRESOLVABLE="~/roverlay/log/dep_unresolvable.log"
+
 
 # --- Other Configuration Options ---
 
@@ -50,7 +54,7 @@ ADDITIONS_DIR="/etc/roverlay/files"
 #USE_EXPAND_RENAME="/etc/roverlay/files/use_expand.rename"
 
 # USE_EXPAND flag description file
-#USE_EXPAND_DESC="/etc/roverlay/file/use_expand.desc"
+#USE_EXPAND_DESC="/etc/roverlay/files/use_expand.desc"
 
 # list of dependency rule files
 # using the default dependency rule files
@@ -58,20 +62,18 @@ ADDITIONS_DIR="/etc/roverlay/files"
 SIMPLE_RULES_FILE="/etc/roverlay/simple-deprules.d"
 
 # list of package rule files/dirs
-PACKAGE_RULES="/etc/roverlay/package-rules.d"
+PACKAGE_RULES="/etc/roverlay/package_rules"
 
 # stats database file
 #  Defaults to "" (disable persistent stats).
-STATS_DB="~/roverlay/cache/stats.rrd"
-
-# database update interval (only used for creating new database files)
-# expected time span between overlay creation runs, in seconds
-#  Defaults to "7200" (2 hours).
-#STATS_INTERVAL="14400"
+STATS_DB="~/roverlay/cache/stats.db"
 
 # script that is run on certain events, e.g. overlay_success
 EVENT_HOOK="/usr/share/roverlay/hooks/mux.sh"
 
+# hook (shell) config file
+EVENT_HOOK_RC="/etc/roverlay/hookrc"
+
 # mask for running hooks
 # Note:
 #  setting -user is highly recommended when running roverlay as root