vcsh: do not create .gitignore.d if VCSH_GITIGNORE == none

[code/vcsh.git] / vcsh

diff --git a/vcsh b/vcsh
index d742cf44cae8c27aeeaa1c796954e0b26bb1a437..e74910e9aca883a0c92673b7a7b60a8f5f41866a 100755 (executable)
--- a/vcsh
+++ b/vcsh
@@ -8,10 +8,13 @@
 # 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
@@ -35,8 +38,10 @@ while getopts "c:dv" flag; do
        if [ "$1" = '-d' ] || [ "$1" = '--debug' ]; then
                set -vx
                VCSH_DEBUG=1
+               echo "$SELF $VERSION"
        elif [ "$1" = '-v' ];then
                VCSH_VERBOSE=1
+               echo "$SELF $VERSION"
        elif [ "$1" = '-c' ];then
                VCSH_OPTION_CONFIG=$OPTARG
        fi
@@ -99,7 +104,7 @@ help() {
           <newname>     Rename repository
    run <repo> \\
        <command>        Use this repository
-   setup <repo>         Set up repository with recommended settings
+   upgrade <repo>       Upgrade repository to currently recommended settings
    version              Print version information
    which <substring>    Find substring in name of any tracked file
    write-gitignore \\
@@ -190,7 +195,7 @@ init() {
        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
-       setup
+       upgrade
 }
 
 list() {
@@ -229,14 +234,14 @@ run() {
        hook post-run
 }
 
-setup() {
-       hook pre-setup
+upgrade() {
+       hook pre-upgrade
        use
        git config core.worktree     "$GIT_WORK_TREE"
-       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'
        [ -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() {
@@ -254,6 +259,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
@@ -267,7 +278,7 @@ write_gitignore() {
        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
@@ -284,8 +295,8 @@ 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
+if [ ! "x$VCSH_GITIGNORE" = 'xexact' ] && [ ! "x$VCSH_GITIGNORE" = 'xrecursive' ] && [ ! "x$VCSH_GITIGNORE" = 'xnone' ]; then
+       fatal "'\$VCSH_GITIGNORE' must equal 'exact', 'recursive', or 'none'" 1
 fi
 
 if [ "$1" = 'clone' ]; then
@@ -309,7 +320,7 @@ 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
@@ -347,9 +358,8 @@ 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
@@ -358,7 +368,10 @@ do
                        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')