Fix style of local variable declarations

Decouple variable declarations so that each can have docstring.
In case of _relck() we also rename variable $relsrc to a more
context-specific term $oracle.

src/include/build.sh

@@ -8,9 +8,9 @@ _build1() {
     #
     # Process one skeleton $1 of type $3 (or guessed) to path $2
     #
-    local srcpath=$1
-    local dstpath=$2
-    local ftype=$3
+    local srcpath=$1    # skeleton path
+    local dstpath=$2    # destination meaty animal path
+    local ftype=$3      # file/builder type
     test -n "$dstpath"  || dstpath=${srcpath%.skel}
     test -n "$ftype"    || ftype=$(_guess_ftype "$dstpath")
     debug_var srcpath dstpath ftype
@@ -23,7 +23,7 @@ _build1_ftype() {
     #
     # Build a file of type $1; fom stdin to stdout
     #
-    local ftype=$1
+    local ftype=$1      # file/builder type
     case $ftype in
         MKIT_COMMON)    _expand_tokens "tokens" ;;
         markdown)       _expand_includes | _expand_tokens "tokens" ;;
@@ -61,8 +61,11 @@ _expand_tokens() {
     #
     # Read stdin, expanding tokens from sections $@
     #
-    local script=$(mktemp --tmpdir mkit-tmp.XXXXXXXXXX)
-    local section varname varvalue
+    local script        # sed script cache
+    local section       # each section to expand tokens from
+    local varname       # each token name
+    local varvalue      # each token value
+    script=$(mktemp --tmpdir mkit-tmp.XXXXXXXXXX)
     {
         for section in "$@";
         do
@@ -93,7 +96,7 @@ _guess_ftype() {
     #
     # Guess file type from destination path $1
     #
-    local dstpath=$1
+    local dstpath=$1    # destination path
     case $dstpath in
         *.md) echo markdown    ;;
         *)    echo MKIT_COMMON ;;
@@ -114,7 +117,7 @@ build() {
     #
     # Add meat to all skeletons
     #
-    local srcpath
+    local srcpath   # each source path
     find -type f -name '*.skel' \
      | while read -r srcpath;
        do
@@ -126,7 +129,8 @@ build_manpages() {
     #
     # Build manpages using ronn
     #
-    local manfile mdfile
+    local manfile   # each manual file listed in '[files:man]'
+    local mdfile    # each source markdown file
     if command -v ronn >/dev/null;
     then
         ini lskeys "files:man" \
@@ -160,7 +164,11 @@ debstuff() {
     #
     # Build Debian stuff (eamed tarball, debian dir)
     #
-    local version="$(semver)"
+    local version       # package version
+    local debian_skel   # 'debian' folder skeleton
+    local dfsrc         # each source file from ^^
+    local dftgt         # each built packaging file
+    version=$(semver)
 
     # tarball - we should already have by means of 'dist'
     #
@@ -171,11 +179,10 @@ debstuff() {
 
     # read content of each mandatory file from debian_skel
     #
-    local debian_skel=$(ini 1value dist:debstuff)
+    debian_skel=$(ini 1value dist:debstuff)
     test -n "$debian_skel" || die "dist:debstuff not specified"
     test -d "$debian_skel" || die "debian directory template found: $debian_skel"
     mkdir -p debian/source
-    local dfsrc dftgt
     find "$debian_skel" -type f \
       | while read -r dfsrc;
         do
@@ -193,9 +200,12 @@ dist() {
     #FIXME: lacking Makefile skills, we do this step twice fot
     #       rpmstuff, hence -f hack for gzip
     #
-    local version=$(semver)
-    local git_lasthash=$(git_lasthash)
-    local dirname=$MKIT_PROJ_PKGNAME-$version
+    local version           # tarball version
+    local git_lasthash      # last git commit hash
+    local dirname           # directory and tarball name
+    version=$(semver)
+    dirname=$MKIT_PROJ_PKGNAME-$version
+    git_lasthash=$(git_lasthash)
     mkdir -p "$dirname"
     ini values "dist:tarball" | xargs -I DIST_ITEM cp -R DIST_ITEM "$dirname"
     update_version "$version" "$dirname/mkit.ini"
@@ -212,8 +222,9 @@ rpmstuff() {
     #
     # Build specfile
     #
-    local specname=$MKIT_PROJ_PKGNAME.spec
-    local specsrc=$(ini 1value "dist:rpmstuff")
+    local specname=$MKIT_PROJ_PKGNAME.spec      # .spec filename
+    local specsrc                               # source of specfile
+    specsrc="$(ini 1value "dist:rpmstuff")"
     test -n "$specsrc" || die "dist:rpmstuff not specified"
     test -f "$specsrc" || die "specfile template not found: $specsrc"
     _build1 "$specsrc" "$specname"

src/include/deploy.sh

@@ -23,9 +23,10 @@ _deploy_item() {
     # Directories are copied recursively, and mode is
     # applied only to files.
     #
-    local src=$1
-    local dst=$2
-    local mode=${3:-$MKIT_DEFAULT_MODE}
+    local src=$1                            # source path
+    local dst=$2                            # destination path
+    local mode=${3:-$MKIT_DEFAULT_MODE}     # mode
+    local chmod_item                        # each file to chmod in directory
     if test -d "$src";
     then
         _maybe mkdir -vp "$(dirname "$dst")"
@@ -44,9 +45,9 @@ _get_dst() {
     #
     # Find out target path for src file $2 of group $1
     #
-    local grp=$1
-    local src=$2
-    local dst=$3
+    local grp=$1        # deploy group
+    local src=$2        # each source
+    local dst=$3        # alternative destination name
     test -n "$dst" || dst=${src##*/}
     echo "$(_get_root "$grp")/$dst"
 }
@@ -55,9 +56,11 @@ _get_root() {
     #
     # Find out target root for group $1
     #
-    local grp=$1
-    local root=$(ini 1value "roots:$grp")
-    local destdir=$(ini 1value ENV:DESTDIR)
+    local grp=$1        # deploy group
+    local root          # root for this group
+    local destdir       # value of DESTDIR
+    root=$(ini 1value "roots:$grp")
+    destdir=$(ini 1value ENV:DESTDIR)
     destdir=${destdir%/}
     case $destdir:$root in
         *:)     die "missing in config.ini: roots:$grp" ;;
@@ -84,7 +87,10 @@ install() {
     #
     # Install product
     #
-    local dst group mode src
+    local group     # each deploy group
+    local mode      # mode (group-specific)
+    local src       # each source path
+    local dst       # each (final absolute) destination path
     ini lskeys "files" \
       | sort \
       | uniq \
@@ -106,7 +112,9 @@ uninstall() {
     #
     # Uninstall product
     #
-    local dst group src
+    local group     # each deploy group
+    local src       # each source path
+    local dst       # each (final absolute) destination path
     ini lskeys "files" \
       | sort \
       | uniq \

src/include/facts.sh

@@ -6,7 +6,7 @@ git_bool() {
     #
     # Get git bool (ie. exit status counts) $1
     #
-    local bool_name=$1
+    local bool_name=$1      # name of boolean to get
     git_present || warn "can't give bool outside git repo: $bool_name"
     case "$bool_name" in
         dirty_files)
@@ -29,7 +29,7 @@ git_fact() {
     #
     # Get git fact $1
     #
-    local fact_name=$1
+    local fact_name=$1      # name of fact to get
     git_present || warn "can't give fact outside git repo: $fact_name"
     case "$fact_name" in
         latest_tag)
@@ -88,9 +88,10 @@ git_lasthash() {
     # work if you got outside the git repo in other way than dist
     # target, but that's actually expected.)
     #
+    local last_hash     # last commit hash
     if git_present;
     then    # we are in git repo
-        local last_hash=$(git rev-parse HEAD)
+        last_hash=$(git rev-parse HEAD)
         echo -n "$last_hash"
         git_bool dirty && echo -n ".dirty"
     else    # we are outside (eg. distributor's build dir')
@@ -146,18 +147,22 @@ semver() {
     # FIXME:  Using project:prerl for release IDs may not be compatible with
     #         release strategy implemented in release.sh
     #
-    local version=$(ini 1value project:version)
-    local prerl=$(ini 1value project:prerl)
+    local version       # version string (final result)
+    local prerl         # pre-release keyword (from mkit.ini, eg. 'alpha')
+    local latest_tag    # latest git tag
+    local commit        # commit indicator (CURRENT_BRANCH.gHASH)
+    local dirty         # 0 if dirty, 1 if clean
+    local suffix        # version suffix
+    version=$(ini 1value project:version)
+    prerl=$(ini 1value project:prerl)
     grep ":" <<<"$prerl" && warn "colon in project:prerl may corrupt version data: $prerl"
     if git_present;
     then    # we are in git repo... so we can get smart
-        local latest_tag=$(git_fact latest_tag)
+        latest_tag=$(git_fact latest_tag)
         if ! git describe --tags --exact-match HEAD >&/dev/null;
         then    # we are at a later commit than the last tag
-            local commit="$(git_fact current_branch).g$(git_fact latest_sha)"
+            commit="$(git_fact current_branch).g$(git_fact latest_sha)"
         fi
-        local dirty=""
-        local suffix=""
         git_bool dirty; dirty=$?
         test -n "$latest_tag" && version=${latest_tag:1}
         case "$dirty:$commit" in

src/include/ini.sh

@@ -4,6 +4,7 @@ _ini_cat() {
     #
     # A no-op for text stream
     #
+    local line      # each line
     while read -r line;
     do
         printf -- "%s\n" "$line"
@@ -14,7 +15,10 @@ _ini_expand() {
     #
     # Expand reference value (prefix only)
     #
-    local line suffix ref value
+    local line      # each input line
+    local suffix    # tail of the line
+    local ref       # reference
+    local value     # value if reference
     while read -r line;                     # [foo:bar]/path
     do
         suffix="${line#\[*\]}"              # /path
@@ -30,7 +34,7 @@ _ini_grepkey() {
     #
     # Read key from a section
     #
-    local wnt=$1
+    local wnt=$1    # wanted key
     grep '.' \
       | grep -v '\s*#' \
       | sed -e 's/ *= */=/; s/ +$//; s/^//;' \
@@ -48,12 +52,13 @@ _ini_greppath() {
     #     [files:share]
     #         my/lib.sh   = proj/my/lib.sh
     #
-    local wnt=$1
-    local wntkey=${wnt##*:}
-    local wntsec=${wnt%:$wntkey}
+    local wnt=$1                    # wanted path
+    local wntkey=${wnt##*:}         # ^^ key part
+    local wntsec=${wnt%:$wntkey}    # ^^ section part
+    local override                  # ENV override (only ENV section)
     if test "$wntsec" = 'ENV';
     then
-        local override=${!wntkey}
+        override=${!wntkey}
         if test -n "$override";
         then
             echo "$override"
@@ -67,8 +72,9 @@ _ini_grepsec() {
     #
     # Read one INI section
     #
-    local wnt=$1
-    local ok=false
+    local wnt=$1        # wanted section name
+    local ok=false      # are we in the section?
+    local line          # each input line
     grep '.' \
       | grep -v '\s*#' \
       | while read -r line;
@@ -87,7 +93,7 @@ _ini_lskeys() {
     #
     # List keys from a section
     #
-    local sct=$1
+    local sct=$1    # section of interest
     _ini_grepsec "$sct" | cut -d= -f1 | sort | uniq
 }
 
@@ -107,10 +113,10 @@ ini() {
     #
     # do ini operation
     #
-    local op=$1
-    local arg=$2
-    local fn
-    local limit=_ini_cat
+    local op=$1             # operator
+    local arg=$2            # argument
+    local fn                # internal function implementing $op
+    local limit=_ini_cat    # limiting internal function
     case $op in
         lskeys) fn=_ini_lskeys   ;;
         sec)    fn=_ini_grepsec  ;;
@@ -125,9 +131,10 @@ update_version() {
     #
     # Change project.version in mkit.ini at path $2 to version $1
     #
-    local version=$1
-    local inifile=$2
-    local tmp=$(mktemp -t mkit.update_version.XXXXXXXX)
+    local version=$1    # new version
+    local inifile=$2    # mkit.ini path
+    local tmp           # mkit.ini cache
+    tmp=$(mktemp -t mkit.update_version.XXXXXXXX)
     <"$inifile" perl -e '
         my $hit = 0;
         my $done = 0;

src/include/mkit.sh

@@ -38,7 +38,7 @@ debug_var() {
     # Print debug message
     #
     $MKIT_DEBUG || return 0
-    local __mkit_debug_var_name__
+    local __mkit_debug_var_name__       # variable name to debug
     for __mkit_debug_var_name__ in "$@";
     do
         {
@@ -65,8 +65,11 @@ _compver() {
     # If our x is 0, check first two fragments, otherwise check just
     # the x.  Fragments must equal.
     #
-    local their_ver our_x our_y their_x their_y
-    their_ver=$1
+    local their_ver=$1      # their version
+    local our_x             # our X
+    local our_y             # our Y
+    local their_x           # their X
+    local their_y           # their Y
     their_x=${their_ver%%.*}
     their_y=${their_ver##$their_x.}
     their_y=${their_y%%.*}
@@ -89,8 +92,8 @@ _chkiniversion() {
     # Look for "#mkit version=0.0.0" or similar in first or last
     # 3 lines of the file; then check if the version is supported.
     #
-    local ver_line
-    local their_ver
+    local ver_line      # line declaring version
+    local their_ver     # the declared version
     ver_line=$(
         {
             head -3 "$MKIT_INI"

src/include/release.sh

@@ -7,14 +7,18 @@ _bump_version() {
     #
     # Bump version on stdin by level $1 (x, y or z)
     #
-    local rlevel=$1
-    local old
+    local rlevel=$1     # release level
+    local old           # old version
+    local oldx          # ... X
+    local oldz          # ... Z
+    local oldy          # ... Y
+    local tmpy          # Y parsing cache
+    local new           # bumped version
     read -r old
-    local oldx=${old%.*.*}
-    local oldz=${old#*.*.}
-    local tmpy=${old%.*}
-    local oldy=${tmpy#*.}
-    local new=""
+    oldx=${old%.*.*}
+    oldz=${old#*.*.}
+    tmpy=${old%.*}
+    oldy=${tmpy#*.}
     case $rlevel in
         x) new="$((oldx+MKIT_BUMPSIZE)).0.0"            ;;
         y) new="$oldx.$((oldy+MKIT_BUMPSIZE)).0"        ;;
@@ -28,18 +32,18 @@ _relck() {
     #
     # Die if blocking condition $1 is detected
     #
-    local condition=$1
-    local x
+    local condition=$1      # condition name
+    local oracle            # expected value
     case "$condition" in
         git_present)
             git rev-parse HEAD >&/dev/null\
              || die "cannot do this outside git repo"
             ;;
         at_relsrc)
-            local relsrc=$(ini 1value project:relsrc)
+            oracle=$(ini 1value project:relsrc)
             git_fact current_branch \
-              | grep -qFx "$relsrc" \
-             || die "you are not on release source branch: $relsrc"
+              | grep -qFx "$oracle" \
+             || die "you are not on release source branch: $oracle"
             ;;
         not_dirty)
             git diff --shortstat 2>/dev/null \
@@ -62,7 +66,7 @@ _relck() {
              && die "WIP commit since $(git_fact latest_tag)"
             ;;
         ini_version)
-            local oracle=$(git_fact latest_version | _bump_version "$rlevel")
+            oracle=$(git_fact latest_version | _bump_version "$rlevel")
             ini 1value project:version  \
               | grep -qFx "$oracle" \
              || die "new version not in mkit.ini: $oracle"
@@ -83,9 +87,9 @@ _release() {
     # FIXME: Using project:prerl as build.sh:semver() does may not be
     #        compatible with this release strategy
     #
-    local rlevel=$1
-    local newtag
-    local reldst
+    local rlevel=$1     # release level (x, y or z)
+    local newtag        # new tag
+    local reldst        # release destination branch (if any)
 
     _relck git_present
     _relck at_relsrc
@@ -133,8 +137,8 @@ _vbump() {
     # Perform checks, compute new version, update mkit.ini and initiate
     # 'Bump version' commit with changelog template.
     #
-    local rlevel=$1
-    local nextver   # after the bump
+    local rlevel=$1     # bump level (x, y or z)
+    local nextver       # version after the bump
     _relck git_present
     _relck at_relsrc
     _relck not_dirty