Improve help text

[code/vcsh.git] / vcsh

diff --git a/vcsh b/vcsh
index 0976d2bcdc226edf4e1ebae778867075cd35bbea..67565b41173ea560326408d41cd05a1eb7b82f54 100755 (executable)
--- a/vcsh
+++ b/vcsh
@@ -1,6 +1,12 @@
 #!/bin/sh
 
-[ -n "$VCSH_DEBUG" ]      && set -x
+# This program is licensed under the GNU GPL version 2 or later.
+# (c) Richard "RichiH" Hartmann, 2011
+# For details, see LICENSE. To submit patches, you have to agree to
+# license your code under the GNU GPL version 2 or later.
+
+
+[ -n "$VCSH_DEBUG" ]      && set -vx
 [ -z "$XDG_CONFIG_HOME" ] && XDG_CONFIG_HOME="$HOME/.config"
 [ -z "$VCSH_BASE" ]       && VCSH_BASE="$XDG_CONFIG_HOME/vcsh/repo.d"
 
@@ -13,20 +19,22 @@ help() {
          [<repo>]       Clone from an existing repository
    help                 Display this help text
    delete               Delete an existing repository
-   enter                Enter repository; spawn new $SHELL
+   enter                Enter repository; spawn new instance of \$SHELL
    init <repo>          Initialize a new repository
    list                 List all repositories
+   list-tracked         List all files tracked by vcsh
+   list-tracked-by \\
+        <repo>          List files tracked by a repository
    rename <repo> \\
           <newname>     Rename repository
    run <repo> \\
        <command>        Use this repository
-
-   seed-gitignore \\
-   <repo>               Seed .gitignore.d/<repo> from git ls-files
    setup                Set up repository with recommended settings
+   write-gitignore \\
+   <repo>               Write .gitignore.d/<repo> via git ls-files
 
-   <repo> <git command> Special command that allows you to run git commands
-                        directly without having to type so much ;)" >&2
+   <repo> <git command> Shortcut to run git commands directly
+   <repo>               Shortcut to enter repository" >&2
 }
 
 debug() {
@@ -110,17 +118,21 @@ list() {
        done
 }
 
-#get_files() {
-#      return $(git ls-files)
-#}
-#
-#list_tracked_all() {
-#      use
-#      for repo in $(list); do
-#              files="$files $(get_files $repo)"
-#      done
-#      echo $files | sort -u
-#}
+get_files() {
+       export GIT_DIR="$VCSH_BASE/$VCSH_REPO_NAME.git"
+       git ls-files
+}
+
+list_tracked() {
+       for VCSH_REPO_NAME in $(list); do
+               get_files
+       done | sort -u
+}
+
+list_tracked_by() {
+       use
+       git ls-files | sort -u
+}
 
 rename() {
        git_dir_exists
@@ -134,7 +146,21 @@ run() {
        $VCSH_EXTERNAL_COMMAND
 }
 
-seed_gitignore() {
+setup() {
+       use
+       git config core.worktree     "$GIT_WORK_TREE"
+       git config core.excludesfile ".gitignore.d/$VCSH_REPO_NAME"
+       git config vcsh.vcsh         'true'
+       [ -e "$HOME/.gitignore.d/$VCSH_REPO_NAME" ] && git add -f "$HOME/.gitignore.d/$VCSH_REPO_NAME"
+}
+
+use() {
+       git_dir_exists
+       export GIT_WORK_TREE="$(git config --get core.worktree)"
+       export VCSH_DIRECTORY="$VCSH_REPO_NAME"
+}
+
+write_gitignore() {
        use
        cd "$HOME" || fatal "could not enter '$HOME'" 11
        gitignores=$(for file in $(git ls-files); do
@@ -163,21 +189,6 @@ seed_gitignore() {
                fatal "could not move '$tempfile' to '$HOME/.gitignore.d/$VCSH_REPO_NAME'" 53
 }
 
-setup() {
-       use
-       git config core.worktree     "$GIT_WORK_TREE"
-       git config core.excludesfile ".gitignore.d/$VCSH_REPO_NAME"
-       git config vcsh.vcsh         'true'
-       touch   "$HOME/.gitignore.d/$VCSH_REPO_NAME" || error "could not touch '$HOME/.gitignore.d/$VCSH_REPO_NAME'"
-       git add "$HOME/.gitignore.d/$VCSH_REPO_NAME"
-}
-
-use() {
-       git_dir_exists
-       export GIT_WORK_TREE="$(git config --get core.worktree)"
-       export VCSH_DIRECTORY="$VCSH_REPO_NAME"
-}
-
 if [ "$1" = 'clone' ]; then
        [ -z $2 ] && fatal "$1: please specify a remote" 1
        export VCSH_COMMAND="$1"
@@ -188,11 +199,11 @@ if [ "$1" = 'clone' ]; then
 elif [ "$1" = 'delete' ] ||
      [ "$1" = 'enter' ] ||
      [ "$1" = 'init' ] ||
-     [ "$1" = 'list-tracked-all' ] ||
+     [ "$1" = 'list-tracked-by' ] ||
      [ "$1" = 'rename' ] ||
      [ "$1" = 'run' ] ||
-     [ "$1" = 'seed-gitignore' ] ||
-     [ "$1" = 'setup' ]; then
+     [ "$1" = 'setup' ] ||
+     [ "$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
@@ -201,22 +212,35 @@ elif [ "$1" = 'delete' ] ||
        export GIT_DIR="$VCSH_BASE/$VCSH_REPO_NAME.git"
        [ "$VCSH_COMMAND" = 'rename' ]         && export GIT_DIR_NEW="$VCSH_BASE/$3.git"
        [ "$VCSH_COMMAND" = 'run' ] && shift 2 && export VCSH_EXTERNAL_COMMAND="$*"
-       [ "$VCSH_COMMAND" = 'seed-gitignore' ]
-#      [ "$VCSH_COMMAND" = 'seed-gitignore' ] && export VCSH_COMMAND='seed_gitignore'
-elif [ "$1" = 'list' ]; then
+       [ "$VCSH_COMMAND" = 'write-gitignore' ]
+elif [ "$1" = 'list' ] ||
+     [ "$1" = 'list-tracked' ]; then
        export VCSH_COMMAND="$1"
-elif [ -n "$1" ]; then
-       export VCSH_COMMAND=run
+elif [ -n "$2" ]; then
+       export VCSH_COMMAND='run'
        export VCSH_REPO_NAME="$1"
        export GIT_DIR="$VCSH_BASE/$VCSH_REPO_NAME.git"
        [ -d $GIT_DIR ] || { help; exit 1; }
        shift 1
        export VCSH_EXTERNAL_COMMAND="git $*"
+elif [ -n "$1" ]; then
+       export VCSH_COMMAND='enter'
+       export VCSH_REPO_NAME="$1"
+       export GIT_DIR="$VCSH_BASE/$VCSH_REPO_NAME.git"
+       [ -d $GIT_DIR ] || { help; exit 1; }
 else
        # $1 is empty, or 'help'
        help && exit
 fi
 
+# Did we receive a directory instead of a name?
+# Mangle the input to fit normal operation.
+if echo $VCSH_REPO_NAME | grep -q '/'; then
+       export GIT_DIR=$VCSH_REPO_NAME
+       export VCSH_REPO_NAME=$(basename $VCSH_REPO_NAME .git)
+fi
+
+
 for check_directory in "$VCSH_BASE" "$HOME/.gitignore.d"
 do
        if [ ! -d "$check_directory" ]; then