git: run in a directory given with -C option

This is similar in spirit to "make -C dir ..." and "tar -C dir ...".

It takes more keypresses to invoke git command in a different
directory without leaving the current directory:

1. (cd ~/foo && git status)
git --git-dir=~/foo/.git --work-dir=~/foo status
GIT_DIR=~/foo/.git GIT_WORK_TREE=~/foo git status
2. (cd ../..; git grep foo)
3. for d in d1 d2 d3; do (cd $d && git svn rebase); done

The methods shown above are acceptable for scripting but are too
cumbersome for quick command line invocations.

With this new option, the above can be done with fewer keystrokes:

1. git -C ~/foo status
2. git -C ../.. grep foo
3. for d in d1 d2 d3; do git -C $d svn rebase; done

A new test script is added to verify the behavior of this option with
other path-related options like --git-dir and --work-tree.

Signed-off-by: Nazri Ramliy <ayiehere@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git.txt b/Documentation/git.txt
index dca11cc96e7f0233fbfa4191cbdd3bb50f91f33e..d6baf98f7916290d0e40c6b83e85084cfbc69528 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -9,7 +9,7 @@ git - the stupid content tracker
 SYNOPSIS
 --------
 [verse]
-'git' [--version] [--help] [-c <name>=<value>]
+'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
     [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
     [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
     [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
@@ -395,6 +395,20 @@ displayed. See linkgit:git-help[1] for more information,
 because `git --help ...` is converted internally into `git
 help ...`.
 
+-C <path>::
+       Run as if git was started in '<path>' instead of the current working
+       directory.  When multiple `-C` options are given, each subsequent
+       non-absolute `-C <path>` is interpreted relative to the preceding `-C
+       <path>`.
++
+This option affects options that expect path name like `--git-dir` and
+`--work-tree` in that their interpretations of the path names would be
+made relative to the working directory caused by the `-C` option. For
+example the following invocations are equivalent:
+
+    git --git-dir=a.git --work-tree=b -C c status
+    git --git-dir=c/a.git --work-tree=c/b status
+
 -c <name>=<value>::
        Pass a configuration parameter to the command. The value
        given will override values from configuration files.

diff --git a/git.c b/git.c
index 2025f77d0181ba646e3c793a693e5d71348b966c..a2d99a7d82104f894edc8f2a473c03f0a69b1f24 100644 (file)
--- a/git.c
+++ b/git.c
@@ -7,7 +7,7 @@
 #include "commit.h"
 
 const char git_usage_string[] =
-       "git [--version] [--help] [-c name=value]\n"
+       "git [--version] [--help] [-C <path>] [-c name=value]\n"
        "           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
        "           [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]\n"
        "           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
@@ -153,6 +153,17 @@ static int handle_options(const char ***argv, int *argc, int *envchanged)
                        set_alternate_shallow_file((*argv)[0]);
                        if (envchanged)
                                *envchanged = 1;
+               } else if (!strcmp(cmd, "-C")) {
+                       if (*argc < 2) {
+                               fprintf(stderr, "No directory given for -C.\n" );
+                               usage(git_usage_string);
+                       }
+                       if (chdir((*argv)[1]))
+                               die_errno("Cannot change to '%s'", (*argv)[1]);
+                       if (envchanged)
+                               *envchanged = 1;
+                       (*argv)++;
+                       (*argc)--;
                } else {
                        fprintf(stderr, "Unknown option: %s\n", cmd);
                        usage(git_usage_string);

diff --git a/t/t0056-git-C.sh b/t/t0056-git-C.sh
new file mode 100755 (executable)
index 0000000..c0006da
--- /dev/null
+++ b/t/t0056-git-C.sh
@@ -0,0 +1,82 @@
+#!/bin/sh
+
+test_description='"-C <path>" option and its effects on other path-related options'
+
+. ./test-lib.sh
+
+test_expect_success '"git -C <path>" runs git from the directory <path>' '
+       test_create_repo dir1 &&
+       echo 1 >dir1/a.txt &&
+       (cd dir1 && git add a.txt && git commit -m "initial in dir1") &&
+       echo "initial in dir1" >expected &&
+       git -C dir1 log --format=%s >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Multiple -C options: "-C dir1 -C dir2" is equivalent to "-C dir1/dir2"' '
+       test_create_repo dir1/dir2 &&
+       echo 1 >dir1/dir2/a.txt &&
+       git -C dir1/dir2 add a.txt &&
+       echo "initial in dir1/dir2" >expected &&
+       git -C dir1/dir2 commit -m "initial in dir1/dir2" &&
+       git -C dir1 -C dir2 log --format=%s >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Effect on --git-dir option: "-C c --git-dir=a.git" is equivalent to "--git-dir c/a.git"' '
+       mkdir c &&
+       mkdir c/a &&
+       mkdir c/a.git &&
+       (cd c/a.git && git init --bare) &&
+       echo 1 >c/a/a.txt &&
+       git --git-dir c/a.git --work-tree=c/a add a.txt &&
+       git --git-dir c/a.git --work-tree=c/a commit -m "initial" &&
+       git --git-dir=c/a.git log -1 --format=%s >expected &&
+       git -C c --git-dir=a.git log -1 --format=%s >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Order should not matter: "--git-dir=a.git -C c" is equivalent to "-C c --git-dir=a.git"' '
+       git -C c --git-dir=a.git log -1 --format=%s >expected &&
+       git --git-dir=a.git -C c log -1 --format=%s >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Effect on --work-tree option: "-C c/a.git --work-tree=../a"  is equivalent to "--work-tree=c/a --git-dir=c/a.git"' '
+       rm c/a/a.txt &&
+       git --git-dir=c/a.git --work-tree=c/a status >expected &&
+       git -C c/a.git --work-tree=../a status >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Order should not matter: "--work-tree=../a -C c/a.git" is equivalent to "-C c/a.git --work-tree=../a"' '
+       git -C c/a.git --work-tree=../a status >expected &&
+       git --work-tree=../a -C c/a.git status >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Effect on --git-dir and --work-tree options - "-C c --git-dir=a.git --work-tree=a" is equivalent to "--git-dir=c/a.git --work-tree=c/a"' '
+       git --git-dir=c/a.git --work-tree=c/a status >expected &&
+       git -C c --git-dir=a.git --work-tree=a status >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Order should not matter: "-C c --git-dir=a.git --work-tree=a" is equivalent to "--git-dir=a.git -C c --work-tree=a"' '
+       git -C c --git-dir=a.git --work-tree=a status >expected &&
+       git --git-dir=a.git -C c --work-tree=a status >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Order should not matter: "-C c --git-dir=a.git --work-tree=a" is equivalent to "--git-dir=a.git --work-tree=a -C c"' '
+       git -C c --git-dir=a.git --work-tree=a status >expected &&
+       git --git-dir=a.git --work-tree=a -C c status >actual &&
+       test_cmp expected actual
+'
+
+test_expect_success 'Relative followed by fullpath: "-C ./here -C /there" is equivalent to "-C /there"' '
+       echo "initial in dir1/dir2" >expected &&
+       git -C dir1 -C "$(pwd)/dir1/dir2" log --format=%s >actual &&
+       test_cmp expected actual
+'
+
+test_done