From: Eric Sunshine <sunshine@sunshineco.com>
Date: Sun, 08 Sep 2013 10:32:07 GMT
Subject: Re: [PATCH v3] Teach git to change to a given directory using -C option
Message-ID: <CAPig+cRt9o=6Amhx6qTkzfk5R9aQfRZ=357BOVELm_hPsWE3WQ@mail.gmail.com>
In-Reply-To: <20130904122020.GA25538@gmail.com>

On Wed, Sep 4, 2013 at 8:20 AM, Nazri Ramliy <ayiehere@gmail.com> wrote:
> Subject: git: run in a directory given with -C option
>
> This is similar in spirit to to "make -C dir ..." and "tar -C dir ...".
> ---
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index 83edf30..ae049da 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -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>".

For consistency with existing formatting in git.txt, you may want to
squash in the following fixes (sans gmail whitespace damage):

--- >8 ---
diff --git a/Documentation/git.txt b/Documentation/git.txt
index ae049da..6622037 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -396,14 +396,14 @@ 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>".
+ 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
+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
--- >8 ---

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

Is the interaction of -C with --work-tree and --git-dir desirable or
useful? (I'm genuinely curious.) Do you have use-cases in mind? Would
mentioning them in the commit message help to justify the interaction?