]> git.madduck.net Git - code/vcsh.git/blobdiff - vcsh

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

vcsh: Improve comments
[code/vcsh.git] / vcsh
diff --git a/vcsh b/vcsh
index d6ee234a2ebd26e4ca10360f44701f304eefb1e4..74b185e8b74efcdf5e93ee43dd7b15f23ce1ce88 100755 (executable)
--- a/vcsh
+++ b/vcsh
 # This should always be the first line of code to facilitate debugging
 [ -n "$VCSH_DEBUG" ] && set -vx
 
-basename() {
-       # Implemented in shell to avoid spawning another process
-       local file
-       file="${1##*/}"
-       [ -z "$2" ] || file="${file%$2}"
-       echo "$file"
-}
-
 SELF=$(basename $0)
-VERSION='1.20130909'
+VERSION='1.20131214.git-HEAD'
 
 fatal() {
        echo "$SELF: fatal: $1" >&2
@@ -40,11 +32,11 @@ while getopts "c:dv" flag; do
                VCSH_DEBUG=1
                echo "debug mode on"
                echo "$SELF $VERSION"
-       elif [ "$1" = '-v' ];then
+       elif [ "$1" = '-v' ]; then
                VCSH_VERBOSE=1
                echo "verbose mode on"
                echo "$SELF $VERSION"
-       elif [ "$1" = '-c' ];then
+       elif [ "$1" = '-c' ]; then
                VCSH_OPTION_CONFIG=$OPTARG
        fi
        shift 1
@@ -61,7 +53,7 @@ source_all() {
 
 # Read configuration and set defaults if anything's not set
 [ -n "$VCSH_DEBUG" ]                  && set -vx
-[ -z "$XDG_CONFIG_HOME" ]             && XDG_CONFIG_HOME="$HOME/.config"
+: ${XDG_CONFIG_HOME:=$HOME/.config}
 
 # Read configuration files if there are any
 [ -r "/etc/vcsh/config" ]             && . "/etc/vcsh/config"
@@ -77,11 +69,11 @@ fi
 [ -n "$VCSH_DEBUG" ]                  && set -vx
 
 # Read defaults
-[ -z "$VCSH_REPO_D" ]                 && VCSH_REPO_D="$XDG_CONFIG_HOME/vcsh/repo.d"
-[ -z "$VCSH_HOOK_D" ]                 && VCSH_HOOK_D="$XDG_CONFIG_HOME/vcsh/hooks-enabled"
-[ -z "$VCSH_BASE" ]                   && VCSH_BASE="$HOME"
-[ -z "$VCSH_GITIGNORE" ]              && VCSH_GITIGNORE='exact'
-[ -z "$VCSH_WORKTREE" ]               && VCSH_WORKTREE='absolute'
+: ${VCSH_REPO_D:=$XDG_CONFIG_HOME/vcsh/repo.d}
+: ${VCSH_HOOK_D:=$XDH_CONFIG_HOME/vcsh/hooks-enabled}
+: ${VCSH_BASE:=$HOME}
+: ${VCSH_GITIGNORE:=exact}
+: ${VCSH_WORKTREE:=absolute}
 
 if [ ! "x$VCSH_GITIGNORE" = 'xexact' ] && [ ! "x$VCSH_GITIGNORE" = 'xnone' ] && [ ! "x$VCSH_GITIGNORE" = 'xrecursive' ]; then
        fatal "'\$VCSH_GITIGNORE' must equal 'exact', 'none', or 'recursive'" 1
@@ -159,11 +151,11 @@ clone() {
        for object in $(git ls-tree -r origin/master | awk '{print $4}'); do
                [ -e "$object" ] &&
                        error "'$object' exists." &&
-                       VCSH_CONFLICT=1;
+                       VCSH_CONFLICT=1
        done
        [ "$VCSH_CONFLICT" = '1' ] &&
                fatal "will stop after fetching and not try to merge!
-  Once this situation has been resolved, run 'vcsh run $VCSH_REPO_NAME git pull' to finish cloning.\n" 17
+  Once this situation has been resolved, run 'vcsh run $VCSH_REPO_NAME git pull' to finish cloning." 17
        git merge origin/master
        hook post-clone
        retire
@@ -255,7 +247,7 @@ list_tracked_by() {
 pull() {
        hook pre-pull
        for VCSH_REPO_NAME in $(list); do
-               echo -n "$VCSH_REPO_NAME: "
+               printf "$VCSH_REPO_NAME: "
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git pull
@@ -267,7 +259,7 @@ pull() {
 push() {
        hook pre-push
        for VCSH_REPO_NAME in $(list); do
-               echo -n "$VCSH_REPO_NAME: "
+               printf "$VCSH_REPO_NAME: "
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git push
@@ -288,7 +280,7 @@ rename() {
        # Now that the repository has been renamed, we need to fix up its configuration
        # Overwrite old name..
        GIT_DIR="$GIT_DIR_NEW"
-       $VCSH_REPO_NAME="$VCSH_REPO_NAME_NEW"
+       VCSH_REPO_NAME="$VCSH_REPO_NAME_NEW"
        # ..and clobber all old configuration
        upgrade
 }
@@ -367,8 +359,9 @@ write_gitignore() {
        done | sort -u)
 
        # Contrary to GNU mktemp, mktemp on BSD/OSX requires a template for temp files
-       # Use the template GNU mktemo defaults to
-       tempfile=$(mktemp tmp.XXXXXXXXXX) || fatal "could not create tempfile" 51
+       # Using a template makes GNU mktemp default to $PWD and not #TMPDIR for tempfile location
+       # To make every OS happy, set full path explicitly
+       tempfile=$(mktemp "${TMPDIR:-/tmp}/tmp.XXXXXXXXXX") || fatal "could not create tempfile: '${tempfile}'" 51
 
        echo '*' > "$tempfile" || fatal "could not write to '$tempfile'" 57
        for gitignore in $gitignores; do
@@ -390,46 +383,70 @@ write_gitignore() {
                fatal "could not move '$tempfile' to '$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME'" 53
 }
 
-if [ "$1" = 'clone' ]; then
-       [ -z "$2" ] && fatal "$1: please specify a remote" 1
-       export VCSH_COMMAND="$1"
+debug `git version`
+
+if [ ! "x$VCSH_GITIGNORE" = 'xexact' ] && [ ! "x$VCSH_GITIGNORE" = 'xnone' ] && [ ! "x$VCSH_GITIGNORE" = 'xrecursive' ]; then
+       fatal "'\$VCSH_GITIGNORE' must equal 'exact', 'none', or 'recursive'" 1
+fi
+
+export VCSH_COMMAND="$1"
+
+case "$VCSH_COMMAND" in
+       clon|clo|cl) VCSH_COMMAND=clone;;
+       commi|comm|com|co) VCSH_COMMAND=commit;;
+       delet|dele|del|de) VCSH_COMMAND=delete;;
+       ente|ent|en) VCSH_COMMAND=enter;;
+       hel|he) VCSH_COMMAND=help;;
+       ini|in) VCSH_COMMAND=init;;
+       pul) VCSH_COMMAND=pull;;
+       pus) VCSH_COMMAND=push;;
+       renam|rena|ren|re) VCSH_COMMAND=rename;;
+       ru) VCSH_COMMAND=run;;
+       statu|stat|sta|st) VCSH_COMMAND=status;;
+       upgrad|upgra|upgr|up) VCSH_COMMAND=upgrade;;
+       versio|versi|vers|ver|ve) VCSH_COMMAND=version;;
+       which|whi|wh) VCSH_COMMAND=which;;
+       write|writ|wri|wr) VCSH_COMMAND=write-gitignore;;
+esac    
+
+if [ "$VCSH_COMMAND" = 'clone' ]; then
+       [ -z "$2" ] && fatal "$VCSH_COMMAND: please specify a remote" 1
        GIT_REMOTE="$2"
        [ -n "$3" ] && VCSH_REPO_NAME="$3" || VCSH_REPO_NAME=$(basename "$GIT_REMOTE" .git)
+       [ -z "$VCSH_REPO_NAME" ] && fatal "$VCSH_COMMAND: could not determine repository name" 1
        export VCSH_REPO_NAME
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
-elif [ "$1" = 'version' ]; then
+elif [ "$VCSH_COMMAND" = 'version' ]; then
        echo "$SELF $VERSION"
+       git version
        exit
-elif [ "$1" = 'which' ]; then
-       [ -z "$2" ] && fatal "$1: please specify a filename" 1
-       [ -n "$3" ] && fatal "$1: too many parameters" 1
-       export VCSH_COMMAND="$1"
+elif [ "$VCSH_COMMAND" = 'which' ]; then
+       [ -z "$2" ] && fatal "$VCSH_COMMAND: please specify a filename" 1
+       [ -n "$3" ] && fatal "$VCSH_COMMAND: too many parameters" 1
        export VCSH_COMMAND_PARAMETER="$2"
-elif [ "$1" = 'delete' ]           ||
-     [ "$1" = 'enter' ]            ||
-     [ "$1" = 'init' ]             ||
-     [ "$1" = 'list-tracked-by' ]  ||
-     [ "$1" = 'rename' ]           ||
-     [ "$1" = 'run' ]              ||
-     [ "$1" = 'upgrade' ]          ||
-     [ "$1" = 'write-gitignore' ]; then
-       [ -z $2 ]                      && fatal "$1: please specify repository to work on" 1
-       [ "$1" = 'rename' -a -z "$3" ] && fatal "$1: please specify a target name" 1
-       [ "$1" = 'run'    -a -z "$3" ] && fatal "$1: please specify a command" 1
-       export VCSH_COMMAND="$1"
+elif [ "$VCSH_COMMAND" = 'delete' ]           ||
+     [ "$VCSH_COMMAND" = 'enter' ]            ||
+     [ "$VCSH_COMMAND" = 'init' ]             ||
+     [ "$VCSH_COMMAND" = 'list-tracked-by' ]  ||
+     [ "$VCSH_COMMAND" = 'rename' ]           ||
+     [ "$VCSH_COMMAND" = 'run' ]              ||
+     [ "$VCSH_COMMAND" = 'upgrade' ]          ||
+     [ "$VCSH_COMMAND" = 'write-gitignore' ]; then
+       [ -z $2 ]                                 && fatal "$VCSH_COMMAND: please specify repository to work on" 1
+       [ "$VCSH_COMMAND" = 'rename' -a -z "$3" ] && fatal "$VCSH_COMMAND: please specify a target name" 1
+       [ "$VCSH_COMMAND" = 'run'    -a -z "$3" ] && fatal "$VCSH_COMMAND: please specify a command" 1
        export VCSH_REPO_NAME="$2"
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
        [ "$VCSH_COMMAND" = 'rename' ] && { export VCSH_REPO_NAME_NEW="$3";
                                            export GIT_DIR_NEW="$VCSH_REPO_D/$VCSH_REPO_NAME_NEW.git"; }
        [ "$VCSH_COMMAND" = 'run' ]    && shift 2
-elif [ "$1" = 'commit' ] ||
-     [ "$1" = 'list' ] ||
-     [ "$1" = 'list-tracked' ] ||
-     [ "$1" = 'pull' ] ||
-     [ "$1" = 'push' ]; then
-       export VCSH_COMMAND="$1"
-elif [ "$1" = 'status' ]; then
-       export VCSH_COMMAND="$1"
+elif [ "$VCSH_COMMAND" = 'commit' ] ||
+     [ "$VCSH_COMMAND" = 'list' ] ||
+     [ "$VCSH_COMMAND" = 'list-tracked' ] ||
+     [ "$VCSH_COMMAND" = 'pull' ] ||
+     [ "$VCSH_COMMAND" = 'push' ]; then
+       :
+elif [ "$VCSH_COMMAND" = 'status' ]; then
        export VCSH_REPO_NAME="$2"
 elif [ -n "$2" ]; then
        export VCSH_COMMAND='run'
@@ -438,7 +455,7 @@ elif [ -n "$2" ]; then
        [ -d $GIT_DIR ] || { help; exit 1; }
        shift 1
        set -- "git" "$@"
-elif [ -n "$1" ]; then
+elif [ -n "$VCSH_COMMAND" ]; then
        export VCSH_COMMAND='enter'
        export VCSH_REPO_NAME="$1"
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"