Add docstrings to globals

src/include/mkit.sh

@@ -5,9 +5,30 @@
 . "$MKIT_DIR/include/release.sh" || die "cannot import release.sh"
 . "$MKIT_DIR/include/ini.sh"    || die "cannot import ini.sh"
 
+#
+# Path to mkit.ini
+#
 MKIT_INI=${MKIT_INI:-mkit.ini}
+
+#
+# Limit ini expansion depth
+#
+# To avoid endless loops, this value is subtracted each
+# time ini() expands a reference; when zero is reached,
+# no more expansions happen.
+#
 MKIT_INI_EXPAND=2
+
+#
+# Package name
+#
+# Used as base for tarball and in some default tokens.
+#
 MKIT_PROJ_PKGNAME=""
+
+#
+# Default deploy mode for files
+#
 MKIT_DEFAULT_MODE="644"
 
 _valid_targets() {

src/make.skel

@@ -6,13 +6,38 @@ die() {
     echo "$@" && exit 9
 }
 
+
+#
+# This MKit version
+#
 export MKIT_VERSION=__MKIT_PROJ_VERSION__
 
+#
+# Path to MKit dir (where 'include' is)
+#
 export MKIT_DIR=${MKIT_DIR:-$(dirname "$0")}
+
+#
+# Path to MKit local config and temp
+#
+# Typically hidden in project root, here MKit can
+# save its temporary lists.
+#
 export MKIT_LOCAL=${MKIT_LOCAL:-.mkit}
+
+#
+# Dry mode (true|false)
+#
+# Set to true to not install anything. Implies MKIT_DEBUG.
+#
 export MKIT_DRY=${MKIT_DRY:-false}
+
+#
+# Debug mode (true|false)
+#
 export MKIT_DEBUG=${MKIT_DEBUG:-false}
 
+
 . "$MKIT_DIR/include/mkit.sh" || die "failed to init; check if MKIT_DIR is set properly: $MKIT_DIR"
 
 case "$1" in