Add RELEASENOTES.txt

This change adds clarity by removing the 'git'
function, which could be easily confused with
the 'git' exectuable

RELEASENOTES.txt

@@ -0,0 +1,19 @@
+v?.?.?
+
+* Set "diff.renameLimit" to unlimited
+  After this change, sourcezap always forwards "-l0" to "git diff"
+
+* Replace utils/gitexec with utils/git/run
+  After this change, we talk to git via utils/git/run
+
+* Add utils/git/
+  A dedicated directory for git-related scripts
+
+* Remove "set -x"
+  After this change, sourcezap emits less output
+
+* Remove scripts
+  Remove "utils/printok", "utils/printerr", "utils/git-rev"
+
+* Add documentation
+  Covers README.md and sourcezap.8

libexec/sourcezap/commands/sourcezap-checkout

@@ -5,6 +5,7 @@ set -e
 # variables
 localbase=${LOCALBASE:-$(realpath "$(dirname "$0")"/../../..)}
 libexec="${localbase}"/libexec/sourcezap
+git="${libexec}"/utils/git/run
 gitdir=$1
 branch=$2
 
@@ -30,6 +31,7 @@ if [ ! -e "${gitdir}/.git" ]; then
 fi
 
 cd "${gitdir}"
-git fetch origin
+"${git}" fetch origin
-git checkout "${branch}" || git checkout -t origin/"${branch}"
+"${git}" checkout "${branch}" ||
+"${git}" checkout -t origin/"${branch}"
 printok "${branch} checked out"

libexec/sourcezap/commands/sourcezap-clone

@@ -5,6 +5,7 @@ set -e
 # variables
 localbase=${LOCALBASE:-$(realpath "$(dirname "$0")"/../../..)}
 libexec="${localbase}"/libexec/sourcezap
+git="${libexec}"/utils/git/run
 giturl=$1
 gitdir=$2
 branch=$3
@@ -30,8 +31,8 @@ if [ -e "${gitdir}/.git" ]; then
     exit 1
 fi
 
-git clone "${giturl}" "${gitdir}"
+"${git}" clone "${giturl}" "${gitdir}"
 cd "${gitdir}"
-git config core.filemode off
+"${git}" config core.filemode off
-git checkout -t origin/"${branch}"
+"${git}" checkout -t origin/"${branch}"
 printok "clone complete"

libexec/sourcezap/commands/sourcezap-install

@@ -6,6 +6,7 @@ set -e
 localbase=${LOCALBASE:-$(realpath "$(dirname "$0")"/../../..)}
 libexec="${localbase}"/libexec/sourcezap
 mode=u=rwX,g=rX,o=
+git="${libexec}"/utils/git/run
 gitdir=$1
 installdir=$2
 revfile=$3
@@ -72,7 +73,7 @@ if [ "$(id -u)" != "0" ]; then
     exit 1
 fi
 
-umask ${mode}
+umask "${mode}"
 cd "${gitdir}"
 run_install "-d" "${installdir}"
 chmod ${mode} "${installdir}"
@@ -81,5 +82,5 @@ if [ -e "${revfile}" ]; then
 else
     perform_install
 fi
-git rev-parse HEAD > "${revfile}"
+"${git}" rev-parse HEAD > "${revfile}"
 printok "install complete"

libexec/sourcezap/commands/sourcezap-pull

@@ -5,6 +5,7 @@ set -e
 # variables
 localbase=${LOCALBASE:-$(realpath "$(dirname "$0")"/../../..)}
 libexec="${localbase}"/libexec/sourcezap
+git="${libexec}"/utils/git/run
 gitdir=$1
 
 ##
@@ -24,12 +25,11 @@ if ! "${libexec}"/utils/issourcezap-member > /dev/null 2>&1; then
 fi
 
 if [ ! -e "${gitdir}/.git" ]; then
-    set +x
     printerr "try 'sourcezap clone' instead"
     exit 1
 fi
 
 cd "${gitdir}"
-branch=$(git branch --show-current)
+branch=$("${git}" branch --show-current)
-git pull --rebase origin "${branch}"
+"${git}" pull --rebase origin "${branch}"
 printok "pull complete"

libexec/sourcezap/functions.sh

@@ -1,10 +1,5 @@
 #!/bin/sh
 
-git()
-{
-    "${libexec}"/utils/git/run "${@}"
-}
-
 printok()
 {
     printf "ok: %s\n" "${@}" > /dev/stdout

libexec/sourcezap/utils/git/get-changed-files

@@ -5,6 +5,7 @@ set -e
 # variables
 localbase=${LOCALBASE:-$(realpath "$(dirname "$0")"/../../../..)}
 libexec="${localbase}"/libexec/sourcezap
+git="${libexec}"/utils/git/run
 gitdir=$1
 commit=$2
 
@@ -15,5 +16,5 @@ commit=$2
 ##
 # main
 cd "${gitdir}"
-git diff -l0 --name-only --diff-filter=A "${commit}" "HEAD"
+"${git}" diff -l0 --name-only --diff-filter=A "${commit}" "HEAD"
-git diff -l0 --name-only --diff-filter=M "${commit}" "HEAD"
+"${git}" diff -l0 --name-only --diff-filter=M "${commit}" "HEAD"

libexec/sourcezap/utils/git/get-removed-files

@@ -5,6 +5,7 @@ set -e
 # variables
 localbase=${LOCALBASE:-$(realpath "$(dirname "$0")"/../../../..)}
 libexec="${localbase}"/libexec/sourcezap
+git="${libexec}"/utils/git/run
 gitdir=$1
 commit=$2
 
@@ -15,4 +16,4 @@ commit=$2
 ##
 # main
 cd "${gitdir}"
-git diff -l0 --name-only --diff-filter=D "${commit}" "HEAD"
+"${git}" diff -l0 --name-only --diff-filter=D "${commit}" "HEAD"