Update and add function docstrings

src/include/build.sh

@@ -6,7 +6,7 @@
 
 _build1() {
     #
-    # Process one skeleton
+    # Process one skeleton $1 of type $3 (or guessed) to path $2
     #
     local srcpath=$1
     local dstpath=$2
@@ -21,7 +21,7 @@ _build1() {
 
 _build1_ftype() {
     #
-    # Build a file of type $1
+    # Build a file of type $1; fom stdin to stdout
     #
     local ftype=$1
     case $ftype in
@@ -59,7 +59,7 @@ _expand_includes() {
 
 _expand_tokens() {
     #
-    # Expand tokens from sections $@
+    # Read stdin, expanding tokens from sections $@
     #
     local script=$(mktemp --tmpdir mkit-tmp.XXXXXXXXXX)
     local section varname varvalue
@@ -123,6 +123,9 @@ build() {
 }
 
 build_manpages() {
+    #
+    # Build manpages using ronn
+    #
     local manfile mdfile
     if command -v ronn >/dev/null;
     then

src/include/release.sh

@@ -127,6 +127,12 @@ _release_msg() {
 }
 
 _vbump() {
+    #
+    # Do version bump at level $1
+    #
+    # Perform checks, compute new version, update mkit.ini and initiate
+    # 'Bump version' commit with changelog template.
+    #
     local rlevel=$1
     local nextver   # after the bump
     _relck git_present
@@ -143,6 +149,9 @@ _vbump() {
 }
 
 _vbump_gitmsg() {
+    #
+    # Compose git message template for 'Bump version' commit
+    #
     echo "Bump version"
     echo ""
     echo "Overview of changes:"
@@ -156,25 +165,43 @@ _vbump_gitmsg() {
 }
 
 release_x() {
+    #
+    # Perform release on X level
+    #
     _release x
 }
 
 release_y() {
+    #
+    # Perform release on Y level
+    #
     _release y
 }
 
 release_z() {
+    #
+    # Perform release on Z level
+    #
     _release z
 }
 
 vbump_x() {
+    #
+    # Perform version bump on X level
+    #
     _vbump x
 }
 
 vbump_y() {
+    #
+    # Perform version bump on Y level
+    #
     _vbump y
 }
 
 vbump_z() {
+    #
+    # Perform version bump on Z level
+    #
     _vbump z
 }

src/make.skel

@@ -4,6 +4,9 @@
 # See LICENSE file for copyright and license details.
 
 die() {
+    #
+    # Poor man's die() (mkit.sh has better)
+    #
     echo "$@" && exit 9
 }