kiss: fix doc-strings for contrib scripts

FossilOrigin-Name: 2591e0f18574cf2aa4e922b747a9db06d5e54e25e17a6a20e68ea60d864cee57

25 files changed, 28 insertions, 39 deletions

diff --git a/contrib/kiss-cargo-urlgen b/contrib/kiss-cargo-urlgen
index 3e453ff..4229062 100755
--- a/contrib/kiss-cargo-urlgen
+++ b/contrib/kiss-cargo-urlgen
@@ -1,5 +1,5 @@
 #!/bin/sh
-
+# Create static cargo sources for Rust packages
 [ "$1" ] || {
     printf '\033[1;33m-> \033[musage: kiss-cargo-urlgen [crate+ver] [crate+ver]\n'
     exit 1
diff --git a/contrib/kiss-cargolock-urlgen b/contrib/kiss-cargolock-urlgen
index f9f377a..372834d 100755
--- a/contrib/kiss-cargolock-urlgen
+++ b/contrib/kiss-cargolock-urlgen
@@ -1,6 +1,5 @@
 #!/bin/sh
-
-# Converts the given Cargo.lock file to static cargo urls
+# Convert the given Cargo.lock file to sources
 
 case "$1" in
     -)  set -- /dev/stdin ;;
diff --git a/contrib/kiss-cat b/contrib/kiss-cat
index 987c10a..5f5cf5d 100755
--- a/contrib/kiss-cat
+++ b/contrib/kiss-cat
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-
-# Concatanate package files in the installed package database.
+# Concatanate package files in the installed package database
 # File names are printed to stderr.
 
 [ "$1" ] || { printf '\033[1;33m-> \033[musage: %s <pkg> [file] [file]\n' "${0##*/}" ; exit 1;}
diff --git a/contrib/kiss-changelog b/contrib/kiss-changelog
index 8963d18..fd4daef 100755
--- a/contrib/kiss-changelog
+++ b/contrib/kiss-changelog
@@ -1,5 +1,4 @@
 #!/bin/sh -e
-
 # Print the git log of the specific package
 
 [ "$1" ] || {
diff --git a/contrib/kiss-chbuild b/contrib/kiss-chbuild
index aefeb10..e478966 100755
--- a/contrib/kiss-chbuild
+++ b/contrib/kiss-chbuild
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-#
-# Create/destroy temporary chroots.
+# Create/destroy temporary chroots
 
 log() { printf '\033[31;1m->\033[m %s.\n' "$@" ;}
 
diff --git a/contrib/kiss-chroot b/contrib/kiss-chroot
index cf0f31d..b7430e8 100755
--- a/contrib/kiss-chroot
+++ b/contrib/kiss-chroot
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-#
-# kiss-chroot: Enter a chroot.
+# Enter a chroot
 
 log() {
     printf '\033[32m->\033[m %s.\n' "$*"
diff --git a/contrib/kiss-depends b/contrib/kiss-depends
index 811b4a9..f972e3f 100755
--- a/contrib/kiss-depends
+++ b/contrib/kiss-depends
@@ -1,6 +1,5 @@
 #!/bin/sh -ef
-#
-# kiss-depends - Display a package's dependencies.
+# Display a package's dependencies
 
 [ "$1" ] || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} <pkg>" ; exit 0 ;}
 
diff --git a/contrib/kiss-depends-finder b/contrib/kiss-depends-finder
index 403723e..91167a3 100755
--- a/contrib/kiss-depends-finder
+++ b/contrib/kiss-depends-finder
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-#
-# Find missing dependencies by parsing 'ldd'.
+# Find missing dependencies by parsing 'ldd'
 
 [ "$1" ] || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} <pkg>" ; exit 0 ;}
 
diff --git a/contrib/kiss-export b/contrib/kiss-export
index 7fce122..10dc3c1 100755
--- a/contrib/kiss-export
+++ b/contrib/kiss-export
@@ -1,6 +1,5 @@
 #!/bin/sh -ef
-#
-# kiss-export - Turn an installed package into a KISS tarball.
+# Turn an installed package into a KISS tarball
 
 [ "$1" ] || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} <pkg>" ; exit 0 ;}
 
diff --git a/contrib/kiss-fork b/contrib/kiss-fork
index a20d142..f450d26 100755
--- a/contrib/kiss-fork
+++ b/contrib/kiss-fork
@@ -1,4 +1,5 @@
 #!/bin/sh -ef
+# Fork a package to the current directory
 
 [ "$1" ]    || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} <pkg>" ; exit 0 ;}
 [ "$KISS_FORCE" ] || {
diff --git a/contrib/kiss-link b/contrib/kiss-link
index dd73864..f76caca 100755
--- a/contrib/kiss-link
+++ b/contrib/kiss-link
@@ -1,4 +1,5 @@
 #!/bin/sh -ef
+# Link a forked package's files to the other repository
 
 [ "$1" ] || { printf '\033[1;33m-> \033[musage: kiss-link [file] [file]\n' ; exit 0 ;}
 
diff --git a/contrib/kiss-maintainer b/contrib/kiss-maintainer
index 2c2d3ed..1561754 100755
--- a/contrib/kiss-maintainer
+++ b/contrib/kiss-maintainer
@@ -1,6 +1,6 @@
 #!/bin/sh -ef
-#
-# kiss-maintainer - find the maintainer of a package.
+# Find the maintainer of a package
+
 [ "$1" ] || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} <pkg>" ; exit 0 ;}
 
 kiss s "$1" | while read -r repo; do cd "$repo"
diff --git a/contrib/kiss-manifest b/contrib/kiss-manifest
index 167738c..84d2526 100755
--- a/contrib/kiss-manifest
+++ b/contrib/kiss-manifest
@@ -1,6 +1,5 @@
 #!/bin/sh -ef
-#
-# kiss-manifest - Display all files owned by a package.
+# Display all files owned by a package
 [ "$1" ] || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} <pkg>" ; exit 0 ;}
 
 kiss l "$1" >/dev/null
diff --git a/contrib/kiss-manifest-tree b/contrib/kiss-manifest-tree
index 609121a..1a9fffe 100755
--- a/contrib/kiss-manifest-tree
+++ b/contrib/kiss-manifest-tree
@@ -1,6 +1,5 @@
 #!/bin/sh -ef
-#
-# kiss-manifest-tree - Display all files owned by a package.
+# Display all files owned by a package with a tree view
 
 [ "$1" ] || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} <pkg>" ; exit 0 ;}
 kiss l "$1" >/dev/null
diff --git a/contrib/kiss-message b/contrib/kiss-message
index c8ac865..f29c8a5 100755
--- a/contrib/kiss-message
+++ b/contrib/kiss-message
@@ -1,6 +1,5 @@
 #!/bin/sh
-
-# Utility for showing package messages in the database.
+# Show messages from a package in the system database
 
 [ "$1" ] || {
     printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} [pkg] [pkg]"
diff --git a/contrib/kiss-new b/contrib/kiss-new
index d50cc5b..491ce9c 100755
--- a/contrib/kiss-new
+++ b/contrib/kiss-new
@@ -1,4 +1,5 @@
 #!/bin/sh -e
+# Create a boilerplate KISS package
 
 out() { printf '\033[1;33m-> \033[m%s\n' "$@" >&2 ;}
 die() { printf '\033[1;31m!> \033[m%s\n' "$@" >&2 ; exit 1 ;}
diff --git a/contrib/kiss-orphans b/contrib/kiss-orphans
index 7b49d07..d8f6776 100755
--- a/contrib/kiss-orphans
+++ b/contrib/kiss-orphans
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-#
-# kiss-orphans - List orphaned packages.
+# List orphaned packages
 
 cd "$KISS_ROOT/var/db/kiss/installed/"
 
diff --git a/contrib/kiss-outdated b/contrib/kiss-outdated
index 81f64e7..27bb1ee 100755
--- a/contrib/kiss-outdated
+++ b/contrib/kiss-outdated
@@ -1,6 +1,5 @@
 #!/bin/sh
-#
-# Check installed packages for updates.
+# Check installed packages for updates
 
 old_IFS=$IFS
 
diff --git a/contrib/kiss-owns b/contrib/kiss-owns
index 79326bf..8745ed6 100755
--- a/contrib/kiss-owns
+++ b/contrib/kiss-owns
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-#
-# kiss-owns - Check which package owns a file.
+# Check which package owns a file
 
 [ "$1" ] || { printf '%s\n' "usage: kiss-owns <file>" ; exit 1 ;}
 
diff --git a/contrib/kiss-repodepends b/contrib/kiss-repodepends
index c5bb399..5fad8d9 100755
--- a/contrib/kiss-repodepends
+++ b/contrib/kiss-repodepends
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-#
-# kiss-repodepends
+# Display a package's dependencies in the repository
 
 [ "$1" ] || { printf '%s\n' "usage: kiss-repodepends <pkg>" ; exit 1 ;}
 kiss s "$1" >/dev/null
diff --git a/contrib/kiss-reset b/contrib/kiss-reset
index ed9613a..a4c225e 100755
--- a/contrib/kiss-reset
+++ b/contrib/kiss-reset
@@ -1,9 +1,8 @@
 #!/bin/sh -ef
+# Remove all packages except for the base
 #
 # Disable word-splittng warnings as they're safe here.
 # shellcheck disable=SC2046
-#
-# kiss-reset: Remove all packages except for the base.
 
 set --
 
diff --git a/contrib/kiss-revdepends b/contrib/kiss-revdepends
index 7855b4a..b2e18b3 100755
--- a/contrib/kiss-revdepends
+++ b/contrib/kiss-revdepends
@@ -1,6 +1,5 @@
 #!/bin/sh -e
-#
-# kiss-revdepends - Display packages which depend on package.
+# Display packages which depend on package
 
 [ "$1" ] || { printf '%s\n' "usage: kiss-revdepends <pkg>" ; exit 1 ;}
 kiss s "$1" >/dev/null
diff --git a/contrib/kiss-size b/contrib/kiss-size
index 1c39bee..c5dc367 100755
--- a/contrib/kiss-size
+++ b/contrib/kiss-size
@@ -1,6 +1,5 @@
 #!/bin/sh -ef
-#
-# kiss-size - Show the size on disk for a package.
+# Show the size on disk for a package
 
 [ "$1" ] || { printf '%s\n' "usage: kiss-size <pkg>" ; exit 1 ;}
 kiss s "$1" >/dev/null
diff --git a/contrib/kiss-which b/contrib/kiss-which
index 2df6f08..a82990d 100755
--- a/contrib/kiss-which
+++ b/contrib/kiss-which
@@ -1,4 +1,5 @@
 #!/bin/sh -e
+# Locate the first instance of a KISS package
 
 [ "$1" ] || { printf '\033[1;33m-> \033[m%s\n' "usage: ${0##*/} [pkg]" ; exit 1 ;}
 
diff --git a/kiss b/kiss
index 5ccab0c..2c7fe34 100755
--- a/kiss
+++ b/kiss
@@ -1475,7 +1475,10 @@ args() {
              done
 
             for path do
-                 printf '\033[31;1m->\033[m %-*s ' "$max" "${path#*/kiss-}"
+                # These are binary files so they should be ignored
+                contains "readlink stat" "$path" && continue
+
+                 printf '\033[31;1m->\033[m %-*s  ' "$max" "${path#*/kiss-}"
                  sed -n 's/^# *//;2p' "$(command -v "kiss-$path")"
              done | sort -uk1 >&2