refactor install instructions to include myrepos

[code/vcsh.git] / vcsh

diff --git a/vcsh b/vcsh
index 3e2a6b6dc09851522e93ff98b23d1bfa8869ce40..029a2b26fa078220f2039030485d121de0e2a3fc 100755 (executable)
--- a/vcsh
+++ b/vcsh
@@ -15,16 +15,12 @@
 # This should always be the first line of code to facilitate debugging
 [ -n "$VCSH_DEBUG" ] && set -vx
 
 # 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"
-}

 
 

+# If '.git-HEAD' is appended to the version, you are seeing an unreleased
+# version of vcsh; the master branch is supposed to be clean at all times
+# so you can most likely just use it nonetheless
+VERSION='1.20131229.git-HEAD'

 SELF=$(basename $0)
 SELF=$(basename $0)

-VERSION='1.20130724'

 
 fatal() {
        echo "$SELF: fatal: $1" >&2
 
 fatal() {
        echo "$SELF: fatal: $1" >&2


@@ -40,11 +36,11 @@ while getopts "c:dv" flag; do
                VCSH_DEBUG=1
                echo "debug mode on"
                echo "$SELF $VERSION"
                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"
                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
                VCSH_OPTION_CONFIG=$OPTARG
        fi
        shift 1


@@ -61,7 +57,7 @@ source_all() {
 
 # Read configuration and set defaults if anything's not set
 [ -n "$VCSH_DEBUG" ]                  && set -vx
 
 # 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"
 
 # Read configuration files if there are any
 [ -r "/etc/vcsh/config" ]             && . "/etc/vcsh/config"


@@ -77,10 +73,19 @@ fi
 [ -n "$VCSH_DEBUG" ]                  && set -vx
 
 # Read defaults
 [ -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'
+: ${VCSH_REPO_D:=$XDG_CONFIG_HOME/vcsh/repo.d}
+: ${VCSH_HOOK_D:=$XDG_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
+fi
+
+if [ ! "x$VCSH_WORKTREE" = 'xabsolute' ] && [ ! "x$VCSH_WORKTREE" = 'xrelative' ]; then
+       fatal "'\$VCSH_WORKTREE' must equal 'absolute', or 'relative'" 1
+fi

 
 
 help() {
 
 
 help() {


@@ -147,15 +152,17 @@ clone() {
                exit
        fi
        git fetch
                exit
        fi
        git fetch

-       for object in $(git ls-tree -r origin/master | awk '{print $4}'); do
+       hook pre-merge
+       git ls-tree -r --name-only origin/master | (while read object; do

                [ -e "$object" ] &&
                        error "'$object' exists." &&
                [ -e "$object" ] &&
                        error "'$object' exists." &&

-                       VCSH_CONFLICT=1;
+                       VCSH_CONFLICT=1

        done
        done

-       [ "$VCSH_CONFLICT" = '1' ] &&
+       [ "$VCSH_CONFLICT" = '1' ]) &&

                fatal "will stop after fetching and not try to merge!
                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
        git merge origin/master

+       hook post-merge

        hook post-clone
        retire
        hook post-clone-retired
        hook post-clone
        retire
        hook post-clone-retired


@@ -168,6 +175,7 @@ commit() {
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git commit --untracked-files=no --quiet
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git commit --untracked-files=no --quiet

+               VCSH_COMMAND_RETURN_CODE=$?

                echo
        done
        hook post-commit
                echo
        done
        hook post-commit


@@ -214,10 +222,9 @@ hook() {
 init() {
        hook pre-init
        [ ! -e "$GIT_DIR" ] || fatal "'$GIT_DIR' exists" 10
 init() {
        hook pre-init
        [ ! -e "$GIT_DIR" ] || fatal "'$GIT_DIR' exists" 10

-       export GIT_WORK_TREE="$VCSH_BASE"
-       mkdir -p "$GIT_WORK_TREE" || fatal "could not create '$GIT_WORK_TREE'" 50
-       cd "$GIT_WORK_TREE" || fatal "could not enter '$GIT_WORK_TREE'" 11
-       git init
+       mkdir -p "$VCSH_BASE" || fatal "could not create '$VCSH_BASE'" 50
+       cd "$VCSH_BASE" || fatal "could not enter '$VCSH_BASE'" 11
+       git init --shared=0600

        upgrade
        hook post-init
 }
        upgrade
        hook post-init
 }


@@ -247,10 +254,11 @@ list_tracked_by() {
 pull() {
        hook pre-pull
        for VCSH_REPO_NAME in $(list); do
 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
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git pull

+               VCSH_COMMAND_RETURN_CODE=$?

                echo
        done
        hook post-pull
                echo
        done
        hook post-pull


@@ -259,17 +267,17 @@ pull() {
 push() {
        hook pre-push
        for VCSH_REPO_NAME in $(list); do
 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
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git push

+               VCSH_COMMAND_RETURN_CODE=$?

                echo
        done
        hook post-push
 }
 
 retire() {
                echo
        done
        hook post-push
 }
 
 retire() {

-       unset GIT_WORK_TREE

        unset VCSH_DIRECTORY
 }
 
        unset VCSH_DIRECTORY
 }
 


@@ -281,7 +289,7 @@ rename() {
        # Now that the repository has been renamed, we need to fix up its configuration
        # Overwrite old name..
        GIT_DIR="$GIT_DIR_NEW"
        # 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
 }
        # ..and clobber all old configuration
        upgrade
 }


@@ -290,6 +298,7 @@ run() {
        hook pre-run
        use
        "$@"
        hook pre-run
        use
        "$@"

+       VCSH_COMMAND_RETURN_CODE=$?

        hook post-run
 }
 
        hook post-run
 }
 


@@ -298,12 +307,14 @@ status() {
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git status --short --untracked-files='no'
                export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                use
                git status --short --untracked-files='no'

+               VCSH_COMMAND_RETURN_CODE=$?

        else
                for VCSH_REPO_NAME in $(list); do
                        echo "$VCSH_REPO_NAME:"
                        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                        use
                        git status --short --untracked-files='no'
        else
                for VCSH_REPO_NAME in $(list); do
                        echo "$VCSH_REPO_NAME:"
                        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
                        use
                        git status --short --untracked-files='no'

+                       VCSH_COMMAND_RETURN_CODE=$?

                        echo
                done
        fi
                        echo
                done
        fi


@@ -311,17 +322,28 @@ status() {
 
 upgrade() {
        hook pre-upgrade
 
 upgrade() {
        hook pre-upgrade

-       use
-       git config core.worktree     "$GIT_WORK_TREE"
+       # fake-bare repositories are not bare, actually. Set this to false
+       # because otherwise Git complains "fatal: core.bare and core.worktree
+       # do not make sense"
+       git config core.bare false
+       # core.worktree may be absolute or relative to $GIT_DIR, depending on
+       # user preference
+       if [ ! "x$VCSH_WORKTREE" = 'xabsolute' ]; then
+               git config core.worktree $(cd $GIT_DIR && GIT_WORK_TREE="$VCSH_BASE" git rev-parse --show-cdup)
+       elif [ ! "x$VCSH_WORKTREE" = 'xrelative' ]; then
+               git config core.worktree "$VCSH_BASE"
+       fi

        [ ! "x$VCSH_GITIGNORE" = 'xnone' ] && git config core.excludesfile ".gitignore.d/$VCSH_REPO_NAME"
        [ ! "x$VCSH_GITIGNORE" = 'xnone' ] && git config core.excludesfile ".gitignore.d/$VCSH_REPO_NAME"

-       git config vcsh.vcsh         'true'
+       git config core.attributesfile ".gitattributes.d/$VCSH_REPO_NAME"
+       git config vcsh.vcsh 'true'
+       use

        [ -e "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME" ] && git add -f "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME"
        [ -e "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME" ] && git add -f "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME"

+       [ -e "$VCSH_BASE/.gitattributes.d/$VCSH_REPO_NAME" ] && git add -f "$VCSH_BASE/.gitattributes.d/$VCSH_REPO_NAME"

        hook post-upgrade
 }
 
 use() {
        git_dir_exists
        hook post-upgrade
 }
 
 use() {
        git_dir_exists

-       export GIT_WORK_TREE="$(git config --get core.worktree)"

        export VCSH_DIRECTORY="$VCSH_REPO_NAME"
 }
 
        export VCSH_DIRECTORY="$VCSH_REPO_NAME"
 }
 


@@ -342,6 +364,8 @@ write_gitignore() {
 
        use
        cd "$VCSH_BASE" || fatal "could not enter '$VCSH_BASE'" 11
 
        use
        cd "$VCSH_BASE" || fatal "could not enter '$VCSH_BASE'" 11

+       OLDIFS="$IFS"
+       IFS=$(printf '\n\t')

        gitignores=$(for file in $(git ls-files); do
                while true; do
                        echo $file; new="${file%/*}"
        gitignores=$(for file in $(git ls-files); do
                while true; do
                        echo $file; new="${file%/*}"


@@ -349,7 +373,12 @@ write_gitignore() {
                        file="$new"
                done;
        done | sort -u)
                        file="$new"
                done;
        done | sort -u)

-       tempfile=$(mktemp) || fatal "could not create tempfile" 51
+
+       # Contrary to GNU mktemp, mktemp on BSD/OSX requires a template for temp files
+       # 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
                echo "$gitignore" | sed 's@^@!/@' >> "$tempfile" || fatal "could not write to '$tempfile'" 57
        echo '*' > "$tempfile" || fatal "could not write to '$tempfile'" 57
        for gitignore in $gitignores; do
                echo "$gitignore" | sed 's@^@!/@' >> "$tempfile" || fatal "could not write to '$tempfile'" 57


@@ -357,6 +386,7 @@ write_gitignore() {
                        { echo "$gitignore/*" | sed 's@^@!/@' >> "$tempfile" || fatal "could not write to '$tempfile'" 57; }
                fi
        done
                        { echo "$gitignore/*" | sed 's@^@!/@' >> "$tempfile" || fatal "could not write to '$tempfile'" 57; }
                fi
        done

+       IFS="$OLDIFS"

        if diff -N "$tempfile" "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME" > /dev/null; then
                rm -f "$tempfile" || error "could not delete '$tempfile'"
                exit
        if diff -N "$tempfile" "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME" > /dev/null; then
                rm -f "$tempfile" || error "could not delete '$tempfile'"
                exit


@@ -370,37 +400,42 @@ write_gitignore() {
                fatal "could not move '$tempfile' to '$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME'" 53
 }
 
                fatal "could not move '$tempfile' to '$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME'" 53
 }
 

+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"
 
 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"
 

-[ "$VCSH_COMMAND" = 'clon' ]   || [ "$VCSH_COMMAND" = 'clo' ]   || [ "$VCSH_COMMAND" = 'cl' ]                                                                && VCSH_COMMAND='clone'
-[ "$VCSH_COMMAND" = 'commi' ]  || [ "$VCSH_COMMAND" = 'comm' ]  || [ "$VCSH_COMMAND" = 'com' ]  || [ "$VCSH_COMMAND" = 'co' ]                                && VCSH_COMMAND='commit'
-[ "$VCSH_COMMAND" = 'delet' ]  || [ "$VCSH_COMMAND" = 'dele' ]  || [ "$VCSH_COMMAND" = 'del' ]  || [ "$VCSH_COMMAND" = 'de' ]                                && VCSH_COMMAND='delete'
-[ "$VCSH_COMMAND" = 'ente' ]   || [ "$VCSH_COMMAND" = 'ent' ]   || [ "$VCSH_COMMAND" = 'en' ]                                                                && VCSH_COMMAND='enter'
-[ "$VCSH_COMMAND" = 'hel' ]    || [ "$VCSH_COMMAND" = 'he' ]                                                                                                 && VCSH_COMMAND='help'
-[ "$VCSH_COMMAND" = 'ini' ]    || [ "$VCSH_COMMAND" = 'in' ]                                                                                                 && VCSH_COMMAND='init'
-[ "$VCSH_COMMAND" = 'pul' ]                                                                                                                                  && VCSH_COMMAND='pull'
-[ "$VCSH_COMMAND" = 'pus' ]                                                                                                                                  && VCSH_COMMAND='push'
-[ "$VCSH_COMMAND" = 'renam' ]  || [ "$VCSH_COMMAND" = 'rena' ]  || [ "$VCSH_COMMAND" = 'ren' ]  || [ "$VCSH_COMMAND" = 're' ]                                && VCSH_COMMAND='rename'
-[ "$VCSH_COMMAND" = 'ru' ]                                                                                                                                   && VCSH_COMMAND='run'
-[ "$VCSH_COMMAND" = 'statu' ]  || [ "$VCSH_COMMAND" = 'stat' ]  || [ "$VCSH_COMMAND" = 'sta' ]  || [ "$VCSH_COMMAND" = 'st' ]                                && VCSH_COMMAND='status'
-[ "$VCSH_COMMAND" = 'upgrad' ] || [ "$VCSH_COMMAND" = 'upgra' ] || [ "$VCSH_COMMAND" = 'upgr' ] || [ "$VCSH_COMMAND" = 'upg' ]                               && VCSH_COMMAND='upgrade'
-[ "$VCSH_COMMAND" = 'versio' ] || [ "$VCSH_COMMAND" = 'versi' ] || [ "$VCSH_COMMAND" = 'vers' ] || [ "$VCSH_COMMAND" = 'ver' ] || [ "$VCSH_COMMAND" = 've' ] && VCSH_COMMAND='version'
-[ "$VCSH_COMMAND" = 'whic' ]   || [ "$VCSH_COMMAND" = 'whi' ]   || [ "$VCSH_COMMAND" = 'wh' ]                                                                && VCSH_COMMAND='which'
-[ "$VCSH_COMMAND" = 'write' ]  || [ "$VCSH_COMMAND" = 'writ' ]  || [ "$VCSH_COMMAND" = 'wri' ]  || [ "$VCSH_COMMAND" = 'wr' ]                                && VCSH_COMMAND='write-gitignore'
-
+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"
 
 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)
+       [ -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 [ "$VCSH_COMMAND" = 'version' ]; then
        echo "$SELF $VERSION"
        export VCSH_REPO_NAME
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
 elif [ "$VCSH_COMMAND" = 'version' ]; then
        echo "$SELF $VERSION"

+       git version

        exit
 elif [ "$VCSH_COMMAND" = 'which' ]; then
        [ -z "$2" ] && fatal "$VCSH_COMMAND: please specify a filename" 1
        exit
 elif [ "$VCSH_COMMAND" = 'which' ]; then
        [ -z "$2" ] && fatal "$VCSH_COMMAND: please specify a filename" 1


@@ -468,6 +503,7 @@ check_dir() {
 
 check_dir "$VCSH_REPO_D"
 [ ! "x$VCSH_GITIGNORE" = 'xnone' ] && check_dir "$VCSH_BASE/.gitignore.d"
 
 check_dir "$VCSH_REPO_D"
 [ ! "x$VCSH_GITIGNORE" = 'xnone' ] && check_dir "$VCSH_BASE/.gitignore.d"

+check_dir "$VCSH_BASE/.gitattributes.d"

 
 verbose "$VCSH_COMMAND begin"
 export VCSH_COMMAND=$(echo $VCSH_COMMAND | sed 's/-/_/g')
 
 verbose "$VCSH_COMMAND begin"
 export VCSH_COMMAND=$(echo $VCSH_COMMAND | sed 's/-/_/g')


@@ -475,3 +511,4 @@ hook pre-command
 $VCSH_COMMAND "$@"
 hook post-command
 verbose "$VCSH_COMMAND end, exiting"
 $VCSH_COMMAND "$@"
 hook post-command
 verbose "$VCSH_COMMAND end, exiting"

+exit $VCSH_COMMAND_RETURN_CODE