]> 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: Support *BSD/OSX mktemp
[code/vcsh.git] / vcsh
diff --git a/vcsh b/vcsh
index b03df7aaca40292c9a15c8e3a4565ffbbc5ae80c..bf843dd1bfb8a4c8593e38accdfd3249bc3819bf 100755 (executable)
--- a/vcsh
+++ b/vcsh
@@ -1,19 +1,30 @@
 #!/bin/sh
 
 # This program is licensed under the GNU GPL version 2 or later.
-# (c) Richard "RichiH" Hartmann <richih.mailinglist@gmail.com>, 2011-2013
+# (c) Richard "RichiH" Hartmann <richih@debian.org>, 2011-2013
 # For details, see LICENSE. To submit patches, you have to agree to
 # license your code under the GNU GPL version 2 or later.
 
 # While the following is not legally binding, the author would like to
 # explain the choice of GPLv2+ over GPLv3+.
 # The author prefers GPLv3+ over GPLv2+ but feels it's better to maintain
-# full compability with git. In case git ever changes its licensing terms,
+# full compatibility's with Git. In case Git ever changes its licensing terms,
 # which is admittedly extremely unlikely to the point of being impossible,
 # this software will most likely follow suit.
 
+# 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.2'
+VERSION='1.20130909'
 
 fatal() {
        echo "$SELF: fatal: $1" >&2
@@ -23,12 +34,16 @@ fatal() {
 # We need to run getops as soon as possible so we catch -d and other
 # options that will modify our behaviour.
 # Commands are handled at the end of this script.
-while getopts  "c:dv" flag; do
+while getopts "c:dv" flag; do
        if [ "$1" = '-d' ] || [ "$1" = '--debug' ]; then
                set -vx
                VCSH_DEBUG=1
+               echo "debug mode on"
+               echo "$SELF $VERSION"
        elif [ "$1" = '-v' ];then
                VCSH_VERBOSE=1
+               echo "verbose mode on"
+               echo "$SELF $VERSION"
        elif [ "$1" = '-c' ];then
                VCSH_OPTION_CONFIG=$OPTARG
        fi
@@ -66,6 +81,15 @@ fi
 [ -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'
+
+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() {
@@ -79,6 +103,7 @@ help() {
    commands:
    clone <remote> \\
          [<repo>]       Clone from an existing repository
+   commit               Commit in all repositories
    delete <repo>        Delete an existing repository
    enter <repo>         Enter repository; spawn new instance of \$SHELL
    help                 Display this help text
@@ -87,11 +112,14 @@ help() {
    list-tracked         List all files tracked by vcsh
    list-tracked-by \\
         <repo>          List files tracked by a repository
+   pull                 Pull from all vcsh remotes
+   push                 Push to vcsh remotes
    rename <repo> \\
           <newname>     Rename repository
    run <repo> \\
        <command>        Use this repository
-   setup <repo>         Set up repository with recommended settings
+   status [<repo>]      Show statuses of all/one vcsh repositories
+   upgrade <repo>       Upgrade repository to currently recommended settings
    version              Print version information
    which <substring>    Find substring in name of any tracked file
    write-gitignore \\
@@ -118,6 +146,7 @@ info() {
 }
 
 clone() {
+       hook pre-clone
        init
        git remote add origin "$GIT_REMOTE"
        git config branch.master.remote origin
@@ -136,6 +165,21 @@ clone() {
                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
        git merge origin/master
+       hook post-clone
+       retire
+       hook post-clone-retired
+}
+
+commit() {
+       hook pre-commit
+       for VCSH_REPO_NAME in $(list); do
+               echo "$VCSH_REPO_NAME: "
+               export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
+               use
+               git commit --untracked-files=no --quiet
+               echo
+       done
+       hook post-commit
 }
 
 delete() {
@@ -177,12 +221,13 @@ hook() {
 }
 
 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
+       mkdir -p "$VCSH_BASE" || fatal "could not create '$VCSH_BASE'" 50
+       cd "$VCSH_BASE" || fatal "could not enter '$VCSH_BASE'" 11
        git init
-       setup
+       upgrade
+       hook post-init
 }
 
 list() {
@@ -207,11 +252,45 @@ list_tracked_by() {
        git ls-files | sort -u
 }
 
+pull() {
+       hook pre-pull
+       for VCSH_REPO_NAME in $(list); do
+               echo -n "$VCSH_REPO_NAME: "
+               export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
+               use
+               git pull
+               echo
+       done
+       hook post-pull
+}
+
+push() {
+       hook pre-push
+       for VCSH_REPO_NAME in $(list); do
+               echo -n "$VCSH_REPO_NAME: "
+               export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
+               use
+               git push
+               echo
+       done
+       hook post-push
+}
+
+retire() {
+       unset VCSH_DIRECTORY
+}
+
 rename() {
        git_dir_exists
        [ -d "$GIT_DIR_NEW" ] && fatal "'$GIT_DIR_NEW' exists" 54
        mv -f "$GIT_DIR" "$GIT_DIR_NEW" || fatal "Could not mv '$GIT_DIR' '$GIT_DIR_NEW'" 52
 
+       # 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"
+       # ..and clobber all old configuration
+       upgrade
 }
 
 run() {
@@ -221,19 +300,44 @@ run() {
        hook post-run
 }
 
-setup() {
-       hook pre-setup
-       use
-       git config core.worktree     "$GIT_WORK_TREE"
-       git config core.excludesfile ".gitignore.d/$VCSH_REPO_NAME"
+status() {
+       if [ ! "x$VCSH_REPO_NAME" = "x" ]; then
+               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'
+                       echo
+               done
+       fi
+}
+
+upgrade() {
+       hook pre-upgrade
+       # 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"
        git config vcsh.vcsh         'true'
+       use
        [ -e "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME" ] && git add -f "$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME"
-       hook post-setup
+       hook post-upgrade
 }
 
 use() {
        git_dir_exists
-       export GIT_WORK_TREE="$(git config --get core.worktree)"
        export VCSH_DIRECTORY="$VCSH_REPO_NAME"
 }
 
@@ -246,6 +350,12 @@ which() {
 }
 
 write_gitignore() {
+       # Don't do anything if the user does not want to write gitignore
+       if [ "x$VCSH_GITIGNORE" = 'xnone' ]; then
+               info "Not writing gitignore as '\$VCSH_GITIGNORE' is set to 'none'"
+               exit
+       fi
+
        use
        cd "$VCSH_BASE" || fatal "could not enter '$VCSH_BASE'" 11
        gitignores=$(for file in $(git ls-files); do
@@ -255,11 +365,11 @@ write_gitignore() {
                        file="$new"
                done;
        done | sort -u)
-       tempfile=$(mktemp) || fatal "could not create tempfile" 51
+       tempfile=$(mktemp tmp.XXXXXXXXXX) || fatal "could not create 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
-               if [ x$VCSH_GITIGNORE = x'recursive' ] && [ -d "$gitignore" ]; then
+               if [ "x$VCSH_GITIGNORE" = 'xrecursive' ] && [ -d "$gitignore" ]; then
                        { echo "$gitignore/*" | sed 's@^@!/@' >> "$tempfile" || fatal "could not write to '$tempfile'" 57; }
                fi
        done
@@ -276,10 +386,6 @@ write_gitignore() {
                fatal "could not move '$tempfile' to '$VCSH_BASE/.gitignore.d/$VCSH_REPO_NAME'" 53
 }
 
-if [ ! "x$VCSH_GITIGNORE" = 'xexact' ] && [ ! "x$VCSH_GITIGNORE" = 'xrecursive' ]; then
-       fatal "'\$VCSH_GITIGNORE' must be either 'exact' or 'recursive'" 1
-fi
-
 if [ "$1" = 'clone' ]; then
        [ -z "$2" ] && fatal "$1: please specify a remote" 1
        export VCSH_COMMAND="$1"
@@ -301,20 +407,26 @@ elif [ "$1" = 'delete' ]           ||
      [ "$1" = 'list-tracked-by' ]  ||
      [ "$1" = 'rename' ]           ||
      [ "$1" = 'run' ]              ||
-     [ "$1" = 'setup' ]            ||
+     [ "$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
+       [ "$1" = 'run'    -a -z "$3" ] && fatal "$1: please specify a command" 1
        export VCSH_COMMAND="$1"
        export VCSH_REPO_NAME="$2"
        export GIT_DIR="$VCSH_REPO_D/$VCSH_REPO_NAME.git"
-       [ "$VCSH_COMMAND" = 'rename' ]         && export GIT_DIR_NEW="$VCSH_REPO_D/$3.git"
-       [ "$VCSH_COMMAND" = 'run' ] && shift 2
-       [ "$VCSH_COMMAND" = 'write-gitignore' ]
-elif [ "$1" = 'list' ] ||
-     [ "$1" = 'list-tracked' ]; then
+       [ "$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"
+       export VCSH_REPO_NAME="$2"
 elif [ -n "$2" ]; then
        export VCSH_COMMAND='run'
        export VCSH_REPO_NAME="$1"
@@ -339,18 +451,20 @@ if echo $VCSH_REPO_NAME | grep -q '/'; then
        export VCSH_REPO_NAME=$(basename "$VCSH_REPO_NAME" .git)
 fi
 
-
-for check_directory in "$VCSH_REPO_D" "$VCSH_BASE/.gitignore.d"
-do
+check_dir() {
+       check_directory="$1"
        if [ ! -d "$check_directory" ]; then
                if [ -e "$check_directory" ]; then
                        fatal "'$check_directory' exists but is not a directory" 13
                else
-                       info "attempting to create '$check_directory'"
+                       verbose "attempting to create '$check_directory'"
                        mkdir -p "$check_directory" || fatal "could not create '$check_directory'" 50
                fi
        fi
-done
+}
+
+check_dir "$VCSH_REPO_D"
+[ ! "x$VCSH_GITIGNORE" = 'xnone' ] && check_dir "$VCSH_BASE/.gitignore.d"
 
 verbose "$VCSH_COMMAND begin"
 export VCSH_COMMAND=$(echo $VCSH_COMMAND | sed 's/-/_/g')