Update own dogfood

utils/mkit/include/build.sh

@@ -6,7 +6,7 @@ mkit_import ini
 mkit_import facts
 
 
-_build1() {
+__build1() {
     #
     # Process one skeleton $1 of type $3 (or guessed) to path $2
     #
@@ -14,52 +14,26 @@ _build1() {
     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")
+    test -n "$ftype"    || ftype=$(__guess_ftype "$dstpath")
     debug_var srcpath dstpath ftype
-    <"$srcpath" _build1_ftype "$ftype" >"$dstpath"
+    <"$srcpath" __build1_ftype "$ftype" >"$dstpath"
     rec_built "$dstpath"
 }
 
-_build1_ftype() {
+__build1_ftype() {
     #
     # Build a file of type $1; fom stdin to stdout
     #
     local ftype=$1      # file/builder type
     case $ftype in
-        MKIT_COMMON)    _expand_tokens "tokens" ;;
-        markdown)       _expand_includes | _expand_tokens "tokens" ;;
-        rpmstuff)       _expand_tokens "tokens" "rpmstuff:tokens" ;;
-        debstuff)       _expand_tokens "tokens" "debstuff:tokens" ;;
+        MKIT_COMMON)    __expand_tokens "tokens" ;;
+        rpmstuff)       __expand_tokens "tokens" "rpmstuff:tokens" ;;
+        debstuff)       __expand_tokens "tokens" "debstuff:tokens" ;;
         *)              die "unknown file type: $ftype" ;;
     esac
 }
 
-_expand_includes() {
-    #
-    # Expand include directives
-    #
-    # Expand e.g. `<!-- include4: foo.sh -->` to include code of foo.sh
-    #
-    perl -we '
-        use strict;
-        my $text;
-        while (<>) {
-            chomp;
-            if (m/<!-- include4: (\S+) -->/) {
-                open my $fh, $1 or warn "cannot find: $1";
-                my $text = do { local($/); <$fh> };
-                close $fh;
-                $text =~ s/^(.)/    $1/gm;
-                chomp $text;
-                print "$text\n";
-            } else {
-                print "$_\n";
-            }
-        }
-    '
-}
-
-_expand_tokens() {
+__expand_tokens() {
     #
     # Read stdin, expanding tokens from sections $@
     #
@@ -73,38 +47,37 @@ _expand_tokens() {
             debug_var section
             ini lskeys "$section" \
               | while read -r varname; do
-                    varvalue="$(ini 1value "$section:$varname" | _qfs )"
+                    varvalue="$(ini 1value "$section:$varname" | __qfs )"
                     echo "s|$varname|$varvalue|g;"
                     debug_var varname varvalue
                 done
         done
-        echo "s|__MKIT_PROJ_NAME__|$(ini 1value project:name | _qfs)|g;"
-        echo "s|__MKIT_PROJ_CODENAME__|$(ini 1value project:codename | _qfs)|g;"
-        echo "s|__MKIT_PROJ_LICENSE__|$(ini 1value project:license | _qfs)|g;"
-        echo "s|__MKIT_PROJ_PKGNAME__|$(ini 1value project:pkgname | _qfs)|g;"
-        echo "s|__MKIT_PROJ_TAGLINE__|$(ini 1value project:tagline | _qfs)|g;"
-        echo "s|__MKIT_PROJ_MAINTAINER__|$(ini 1value project:maintainer | _qfs)|g;"
-        echo "s|__MKIT_PROJ_VCS_BROWSER__|$(ini 1value project:vcs_browser | _qfs)|g;"
-        echo "s|__MKIT_PROJ_GIT_LASTHASH__|$(git_lasthash | _qfs)|g;"
-        echo "s|__MKIT_PROJ_VERSION__|$(semver | _qfs)|g;"
+        echo "s|__MKIT_PROJ_NAME__|$(ini 1value project:name | __qfs)|g;"
+        echo "s|__MKIT_PROJ_CODENAME__|$(ini 1value project:codename | __qfs)|g;"
+        echo "s|__MKIT_PROJ_LICENSE__|$(ini 1value project:license | __qfs)|g;"
+        echo "s|__MKIT_PROJ_PKGNAME__|$(ini 1value project:pkgname | __qfs)|g;"
+        echo "s|__MKIT_PROJ_TAGLINE__|$(ini 1value project:tagline | __qfs)|g;"
+        echo "s|__MKIT_PROJ_MAINTAINER__|$(ini 1value project:maintainer | __qfs)|g;"
+        echo "s|__MKIT_PROJ_VCS_BROWSER__|$(ini 1value project:vcs_browser | __qfs)|g;"
+        echo "s|__MKIT_PROJ_GIT_LASTHASH__|$(git_lasthash | __qfs)|g;"
+        echo "s|__MKIT_PROJ_VERSION__|$(semver | __qfs)|g;"
         echo "s|__MKIT_SELF_VERSION__|$MKIT_VERSION|g;"
     } >> "$script"
-    sed -f "$script" || die "_expand_tokens failed"
+    sed -f "$script" || die "__expand_tokens failed"
     rm "$script"
 }
 
-_guess_ftype() {
+__guess_ftype() {
     #
     # Guess file type from destination path $1
     #
     local dstpath=$1    # destination path
     case $dstpath in
-        *.md) echo markdown    ;;
         *)    echo MKIT_COMMON ;;
     esac
 }
 
-_qfs() {
+__qfs() {
     #
     # Quote for our sed scipt's RHS
     #
@@ -114,6 +87,39 @@ _qfs() {
     '
 }
 
+_mkit_data() {
+    #
+    # Build sampler showing all token values
+    #
+    local token
+    local section
+    local sections
+    sections=()
+    ini lskeys tokens | grep -q . && sections=(tokens)
+    sections+=( $(ini lssect | grep ':tokens$') )
+    {
+        echo "(builtin):"
+        echo "  x_MKIT_PROJ_NAME__ => '__MKIT_PROJ_NAME__'"
+        echo "  x_MKIT_PROJ_CODENAME__ => '__MKIT_PROJ_CODENAME__'"
+        echo "  x_MKIT_PROJ_LICENSE__ => '__MKIT_PROJ_LICENSE__'"
+        echo "  x_MKIT_PROJ_PKGNAME__ => '__MKIT_PROJ_PKGNAME__'"
+        echo "  x_MKIT_PROJ_TAGLINE__ => '__MKIT_PROJ_TAGLINE__'"
+        echo "  x_MKIT_PROJ_MAINTAINER__ => '__MKIT_PROJ_MAINTAINER__'"
+        echo "  x_MKIT_PROJ_VCS_BROWSER__ => '__MKIT_PROJ_VCS_BROWSER__'"
+        echo "  x_MKIT_PROJ_GIT_LASTHASH__ => '__MKIT_PROJ_GIT_LASTHASH__'"
+        echo "  x_MKIT_PROJ_VERSION__ => '__MKIT_PROJ_VERSION__'"
+        echo "  x_MKIT_SELF_VERSION__ => '__MKIT_SELF_VERSION__'"
+        for section in "${sections[@]}"; do
+            echo "$section:"
+            for token in $(ini lskeys "$section"); do
+                echo "  x${token:1} => '$token'"
+            done
+        done
+    } \
+      | __expand_tokens "MKIT_BUILTIN" "${sections[@]}" \
+      | sed '/^  x/ s|x|_|'
+}
+
 build() {
     #
     # Add meat to all skeletons
@@ -122,29 +128,10 @@ build() {
     semver >/dev/null
     find . -type f -name '*.skel' \
      | while read -r srcpath; do
-           _build1 "$srcpath"
+           __build1 "$srcpath"
        done
 }
 
-build_manpages() {
-    #
-    # Build manpages using ronn
-    #
-    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" \
-          | while read -r manfile; do
-                mdfile="$manfile.md"
-                ronn -r "$mdfile"
-                rec_built "$manfile"
-            done
-    else
-        echo "ronn is not installed"
-        return 1
-    fi
-}
-
 clean() {
     #
     # Clean up tree after building
@@ -185,7 +172,7 @@ debstuff() {
       | while read -r dfsrc; do
             dftgt="debian/${dfsrc#$debian_skel}"
             mkdir -p "$(dirname "$dftgt")"
-            _build1 "$dfsrc" "$dftgt" debstuff
+            __build1 "$dfsrc" "$dftgt" debstuff
         done
     rec_built debian
 }
@@ -194,7 +181,7 @@ dist() {
     #
     # Create distributable tarball
     #
-    #FIXME: lacking Makefile skills, we do this step twice fot
+    #FIXME: lacking Makefile skills, we do this step twice for
     #       rpmstuff, hence -f hack for gzip
     #
     local version           # tarball version
@@ -223,5 +210,5 @@ rpmstuff() {
     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" rpmstuff
+    __build1 "$specsrc" "$specname" rpmstuff
 }

utils/mkit/include/deploy.sh

@@ -4,11 +4,11 @@
 
 mkit_import ini
 
-_deploy_item() {
+__deploy_item() {
     #
     # Deploy item and make it look like wanted
     #
-    # usage: _deploy_item src dst [mode]
+    # usage: __deploy_item src dst [mode]
     #
     # Both src and dst must be names of actual items[1],
     # whereas dst must not exist.  On update, dst is
@@ -37,14 +37,14 @@ _deploy_item() {
                 [[ $item =~ .skel$ ]] \
                  && grep -q "${item%.skel}" "$MKIT_LOCAL/built.lst" \
                  && continue
-                _deploy_item "$item" "$dst${item#$src}" "$mode"
+                __deploy_item "$item" "$dst${item#$src}" "$mode"
             done
     else
-        _maybe install -DTvm "$mode" "$src" "$dst"
+        __maybe install -DTvm "$mode" "$src" "$dst"
     fi
 }
 
-_get_dst() {
+__get_dst() {
     #
     # Find out target path for src file $2 of group $1
     #
@@ -52,10 +52,10 @@ _get_dst() {
     local src=$2        # each source
     local dst=$3        # alternative destination name
     test -n "$dst" || dst=${src##*/}
-    echo "$(_get_root "$grp")/$dst"
+    echo "$(__get_root "$grp")/$dst"
 }
 
-_get_root() {
+__get_root() {
     #
     # Find out target root for group $1
     #
@@ -72,7 +72,7 @@ _get_root() {
     esac
 }
 
-_maybe() {
+__maybe() {
     #
     # Call the deploy command $1 $@ unless in dry mode
     #
@@ -101,8 +101,8 @@ install() {
             mode=$(ini 1value "modes:$group")
             ini values "files:$group" \
               | while read -r src dst; do
-                    dst=$(_get_dst "$group" "$src" "$dst")
-                    _deploy_item "$src" "$dst" "$mode"
+                    dst=$(__get_dst "$group" "$src" "$dst")
+                    __deploy_item "$src" "$dst" "$mode"
                 done
         done
     test -f "$MKIT_LOCAL/autoclean" && clean
@@ -122,8 +122,8 @@ uninstall() {
       | while read -r group; do
             ini values "files:$group" \
               | while read -r src dst; do
-                    dst=$(_get_dst "$group" "$src" "$dst")
-                    _maybe rm -vrf "$dst"
+                    dst=$(__get_dst "$group" "$src" "$dst")
+                    __maybe rm -vrf "$dst"
                 done
         done
 }

utils/mkit/include/ini.sh

@@ -2,7 +2,7 @@
 # MKit - simple install helper
 # See LICENSE file for copyright and license details.
 
-_ini_cat() {
+__ini_cat() {
     #
     # A no-op for text stream
     #
@@ -12,7 +12,7 @@ _ini_cat() {
     done
 }
 
-_ini_expand() {
+__ini_expand() {
     #
     # Expand reference value (prefix only)
     #
@@ -30,7 +30,7 @@ _ini_expand() {
     done
 }
 
-_ini_grepkey() {
+__ini_grepkey() {
     #
     # Read key from a section
     #
@@ -40,10 +40,10 @@ _ini_grepkey() {
       | sed -e 's/ *= */=/; s/ +$//; s/^//;' \
       | grep -e "^$wnt=" \
       | cut -d= -f2- \
-      | _ini_maybe_expand
+      | __ini_maybe_expand
 }
 
-_ini_greppath() {
+__ini_greppath() {
     #
     # Read key from the right section
     #
@@ -62,10 +62,10 @@ _ini_greppath() {
          && echo "$override" \
          && return
     fi
-    _ini_grepsec "$wntsec" | _ini_grepkey "$wntkey"
+    __ini_grepsec "$wntsec" | __ini_grepkey "$wntkey"
 }
 
-_ini_grepsec() {
+__ini_grepsec() {
     #
     # Read one INI section
     #
@@ -85,22 +85,30 @@ _ini_grepsec() {
       | sed -e 's/ *= */=/; s/ +$//; s/^//;'
 }
 
-_ini_lskeys() {
+__ini_lskeys() {
     #
     # List keys from a section
     #
     local sct=$1    # section of interest
-    _ini_grepsec "$sct" | cut -d= -f1 | awk '!x[$0]++'
+    __ini_grepsec "$sct" | cut -d= -f1 | awk '!x[$0]++'
 }
 
-_ini_maybe_expand() {
+__ini_lssect() {
+    #
+    # List all section names
+    #
+    local arg=$1    # unused argument
+    grep -x '\[.*\]' | sed 's/^.//; s/.$//'
+}
+
+__ini_maybe_expand() {
     #
     # Decide whether or not to expand
     #
     if test "$MKIT_INI_EXPAND" -gt 0; then
-        MKIT_INI_EXPAND=$(( --MKIT_INI_EXPAND )) _ini_expand
+        MKIT_INI_EXPAND=$(( --MKIT_INI_EXPAND )) __ini_expand
     else
-        _ini_cat
+        __ini_cat
     fi
 }
 
@@ -111,12 +119,13 @@ ini() {
     local op=$1             # operator
     local arg=$2            # argument
     local fn                # internal function implementing $op
-    local limit=_ini_cat    # limiting internal function
+    local limit=__ini_cat    # limiting internal function
     case $op in
-        lskeys) fn=_ini_lskeys   ;;
-        sec)    fn=_ini_grepsec  ;;
-        values) fn=_ini_greppath ;;
-        1value) fn=_ini_greppath; limit="tail -1" ;;
+        lskeys) fn=__ini_lskeys   ;;
+        lssect) fn=__ini_lssect   ;;
+        sec)    fn=__ini_grepsec  ;;
+        values) fn=__ini_greppath ;;
+        1value) fn=__ini_greppath; limit="tail -1" ;;
         *)      die "incorrect use of \`ini()\`"
     esac
     <"$MKIT_INI" $fn "$arg" | $limit
@@ -124,7 +133,7 @@ ini() {
 
 update_version() {
     #
-    # Change project.version in mkit.ini at path $2 to version $1
+    # Change project:version in mkit.ini at path $2 to value $1
     #
     local version=$1    # new version
     local inifile=$2    # mkit.ini path

utils/mkit/include/mkit.sh

@@ -30,12 +30,12 @@ mkit_import deploy
 mkit_import release
 mkit_import ini
 
-_valid_targets() {
+__valid_targets() {
     #
     # List valid routes
     #
+    echo _mkit_data
     echo build
-    echo build_manpages
     echo clean
     echo debstuff
     echo dist
@@ -76,7 +76,7 @@ debug_var() {
     done
 }
 
-_compver() {
+__compver() {
     #
     # True if version $1 matches our version
     #
@@ -103,7 +103,7 @@ _compver() {
     return 0
 }
 
-_chkiniversion() {
+__chkiniversion() {
     #
     # Check if ini version is supported
     #
@@ -121,7 +121,7 @@ _chkiniversion() {
     test -n "$ver_line" \
      || die "version mark ('#mkit version=x.y.z') not found in: $MKIT_INI"
     their_ver="$(tr -d '[:blank:]v' <<<"${ver_line##*=}")"
-    _compver "$their_ver" \
+    __compver "$their_ver" \
      || die "bad mkit.ini version: $their_ver does not match $MKIT_VERSION"
 }
 
@@ -160,7 +160,7 @@ mkit_init() {
     #shellcheck disable=SC2034
     MKIT_PROJ_PKGNAME=$(ini 1value "project:pkgname")
     test -f "$MKIT_INI" || die "cannot find mkit.ini: $MKIT_INI"
-    _chkiniversion
+    __chkiniversion
 }
 
 rec_built() {
@@ -176,14 +176,14 @@ route() {
     #
     # Call correct function based on $1
     #
-    if _valid_targets | grep -qwx "^$1"; then
+    if __valid_targets | grep -qwx "^$1"; then
         "$1"
     else
         {
             echo "usage: $(basename "$0") TARGET"
             echo
             echo "valid targets:"
-            _valid_targets | sed 's/^/    /'
+            __valid_targets | sed 's/^/    /'
         } >&2
     fi
 }

utils/mkit/include/release.sh

@@ -5,7 +5,7 @@
 mkit_import ini
 mkit_import facts
 
-_bump_version() {
+__bump_version() {
     #
     # Bump version on stdin by level $1 (x, y or z)
     #
@@ -30,7 +30,7 @@ _bump_version() {
     echo "$new"
 }
 
-_relck() {
+__relck() {
     #
     # Die if blocking condition $1 is detected
     #
@@ -68,7 +68,7 @@ _relck() {
              && die "WIP commit since $(git_fact latest_tag)"
             ;;
         ini_version)
-            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"
@@ -79,7 +79,7 @@ _relck() {
     esac
 }
 
-_release() {
+__release() {
     #
     # Prepare release
     #
@@ -94,19 +94,19 @@ _release() {
     local relsrc        # release source branch (if any)
     local reldst        # release destination branch (if any)
 
-    _relck git_present
-    _relck at_relsrc
-    _relck not_dirty
-    _relck tags_ok
-    _relck vbump_hot
-    _relck no_wip
-    _relck ini_version
+    __relck git_present
+    __relck at_relsrc
+    __relck not_dirty
+    __relck tags_ok
+    __relck vbump_hot
+    __relck no_wip
+    __relck ini_version
 
-    newtag=$(git_fact latest_version | _bump_version "$rlevel" | git_ver2tag )
+    newtag=$(git_fact latest_version | __bump_version "$rlevel" | git_ver2tag )
     set -e
     debug_var newtag
     $MKIT_DRY && return
-    git tag -m "$(_release_msg)" "$newtag"
+    git tag -m "$(__release_msg)" "$newtag"
 
     relsrc=$(ini 1value project:relsrc)
     reldst=$(ini 1value project:reldst)
@@ -116,7 +116,7 @@ _release() {
     fi
 }
 
-_release_msg() {
+__release_msg() {
     #
     # Generate message for annotated tag
     #
@@ -133,7 +133,7 @@ _release_msg() {
       | tail -n +3
 }
 
-_vbump() {
+__vbump() {
     #
     # Do version bump at level $1
     #
@@ -142,10 +142,10 @@ _vbump() {
     #
     local rlevel=$1     # bump level (x, y or z)
     local nextver       # version after the bump
-    _relck git_present
-    _relck at_relsrc
-    _relck not_dirty
-    nextver=$(ini 1value project:version | _bump_version "$rlevel")
+    __relck git_present
+    __relck at_relsrc
+    __relck not_dirty
+    nextver=$(ini 1value project:version | __bump_version "$rlevel")
     debug_var nextver
     $MKIT_DRY && return
     update_version "$nextver" mkit.ini \
@@ -165,7 +165,7 @@ _vbump_gitmsg() {
     echo ""
     git_fact reldiff \
       | sed '
-            s/^[a-f0-9]\{7\} / *  &/; t PATHS
+            s/^[a-f0-9]\{7\} /\n *  &/; t PATHS
             s/^/        /
             :PATHS
         '
@@ -175,54 +175,54 @@ release() {
     #
     # Perform release on Z level
     #
-    _release z
+    __release z
 }
 
 release_x() {
     #
     # Perform release on X level
     #
-    _release x
+    __release x
 }
 
 release_y() {
     #
     # Perform release on Y level
     #
-    _release y
+    __release y
 }
 
 release_z() {
     #
     # Perform release on Z level
     #
-    _release z
+    __release z
 }
 
 vbump() {
     #
     # Perform version bump on Z level
     #
-    _vbump z
+    __vbump z
 }
 
 vbump_x() {
     #
     # Perform version bump on X level
     #
-    _vbump x
+    __vbump x
 }
 
 vbump_y() {
     #
     # Perform version bump on Y level
     #
-    _vbump y
+    __vbump y
 }
 
 vbump_z() {
     #
     # Perform version bump on Z level
     #
-    _vbump z
+    __vbump z
 }

utils/mkit/include/vars.sh

@@ -58,4 +58,4 @@ MKIT_PROJ_PKGNAME=""
 #
 # This MKit version
 #
-MKIT_VERSION=0.0.24+master.g1446c26
+MKIT_VERSION=0.0.25+master.gf8bcff1

utils/mkit/mkit.mk

@@ -5,52 +5,52 @@ export MKIT_DIR
 
 all: build
 
-build:
-	@$(MKIT_DIR)/make build
+_mkit_data:
+	@"$(MKIT_DIR)"/make _mkit_data
 
-manpages: build
-	@$(MKIT_DIR)/make build_manpages
+build:
+	@"$(MKIT_DIR)"/make build
 
 clean:
-	@$(MKIT_DIR)/make clean
+	@"$(MKIT_DIR)"/make clean
 
 debstuff: dist
-	@$(MKIT_DIR)/make debstuff
+	@"$(MKIT_DIR)"/make debstuff
 
 dist: clean
-	@$(MKIT_DIR)/make dist
+	@"$(MKIT_DIR)"/make dist
 
 rpmstuff: dist
-	@$(MKIT_DIR)/make rpmstuff
+	@"$(MKIT_DIR)"/make rpmstuff
 
 install: all
-	@$(MKIT_DIR)/make install
+	@"$(MKIT_DIR)"/make install
 
 release:
-	@$(MKIT_DIR)/make release
+	@"$(MKIT_DIR)"/make release
 
 release_x:
-	@$(MKIT_DIR)/make release_x
+	@"$(MKIT_DIR)"/make release_x
 
 release_y:
-	@$(MKIT_DIR)/make release_y
+	@"$(MKIT_DIR)"/make release_y
 
 release_z:
-	@$(MKIT_DIR)/make release_z
+	@"$(MKIT_DIR)"/make release_z
 
 uninstall:
-	@$(MKIT_DIR)/make uninstall
+	@"$(MKIT_DIR)"/make uninstall
 
 vbump:
-	@$(MKIT_DIR)/make vbump
+	@"$(MKIT_DIR)"/make vbump
 
 vbump_x:
-	@$(MKIT_DIR)/make vbump_x
+	@"$(MKIT_DIR)"/make vbump_x
 
 vbump_y:
-	@$(MKIT_DIR)/make vbump_y
+	@"$(MKIT_DIR)"/make vbump_y
 
 vbump_z:
-	@$(MKIT_DIR)/make vbump_z
+	@"$(MKIT_DIR)"/make vbump_z
 
-.PHONY: all clean dist rpmstuff install uninstall release release_x release_y release_z vbump vbump_x vbump_y vbump_z
+.PHONY: all _mkit_data clean dist rpmstuff install uninstall release release_x release_y release_z vbump vbump_x vbump_y vbump_z