# bug: git submodule add fails when .git is a symlink

9 messages from 2016-03-01 to 2016-04-20. Participants: Joey Hess, Stefan Beller, Junio C Hamano, Jeff King.
Thread: https://gitlist.dev/t/41585

## Joey Hess, 2016-03-01 20:42

Subject: bug: git submodule add fails when .git is a symlink
Message-ID: <20160301204218.GA4083@kitenet.net>
URL: https://gitlist.dev/e/20160301204218.GA4083%40kitenet.net

```
        git init gitdir
        mkdir worktree
        cd worktree
        ln -s ../gitdir/.git .git
        git submodule add /any/git/repo sub

        fatal: Could not chdir to '../../../sub': No such file or directory

Fairly sure this is a bug..

-- 
see shy jo

```

## Stefan Beller, 2016-03-01 21:39

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <CAGZ79kY6Lf6u0=s8J_cqRNFsry4nu2SdL0GZ2gkFsu6gBrB65Q@mail.gmail.com>
URL: https://gitlist.dev/e/CAGZ79kY6Lf6u0%3Ds8J_cqRNFsry4nu2SdL0GZ2gkFsu6gBrB65Q%40mail.gmail.com
In-Reply-To: <20160301204218.GA4083@kitenet.net>

```
On Tue, Mar 1, 2016 at 12:42 PM, Joey Hess <id@joeyh.name> wrote:
>         git init gitdir
>         mkdir worktree
>         cd worktree
>         ln -s ../gitdir/.git .git
>         git submodule add /any/git/repo sub
>
>         fatal: Could not chdir to '../../../sub': No such file or directory
>
> Fairly sure this is a bug..

Which version(s) of Git do you use?

```

## Stefan Beller, 2016-03-01 21:49

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <CAGZ79kbV9y6nDuBgqLbzQ=xaroG_uF8RF6gqzk=unJ-9rrtvfw@mail.gmail.com>
URL: https://gitlist.dev/e/CAGZ79kbV9y6nDuBgqLbzQ%3DxaroG_uF8RF6gqzk%3DunJ-9rrtvfw%40mail.gmail.com
In-Reply-To: <CAGZ79kY6Lf6u0=s8J_cqRNFsry4nu2SdL0GZ2gkFsu6gBrB65Q@mail.gmail.com>

```
On Tue, Mar 1, 2016 at 1:39 PM, Stefan Beller <sbeller@google.com> wrote:
> On Tue, Mar 1, 2016 at 12:42 PM, Joey Hess <id@joeyh.name> wrote:
>>         git init gitdir
>>         mkdir worktree
>>         cd worktree
>>         ln -s ../gitdir/.git .git
>>         git submodule add /any/git/repo sub
>>
>>         fatal: Could not chdir to '../../../sub': No such file or directory
>>
>> Fairly sure this is a bug..
>
> Which version(s) of Git do you use?

To elaborate on that: Starting in 2.7 parts of the submodule stuff
has been rewritten in C, in 2.8 even more and there is more in flight for
 > 2.8.

However your bug is also to be found in 2.6, which doesn't contain any
recent rewrites, so it is a rather long standing bug, I would presume.

As a workaround for now:

    echo "gitdir: ../gitdir/.git" > .git

instead of the symbolic link in your example (works in 2.6 and also in
2.8.0-rc0)

Thanks,
Stefan

```

## Junio C Hamano, 2016-03-01 21:50

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <xmqq8u217tqa.fsf@gitster.mtv.corp.google.com>
URL: https://gitlist.dev/e/xmqq8u217tqa.fsf%40gitster.mtv.corp.google.com
In-Reply-To: <CAGZ79kY6Lf6u0=s8J_cqRNFsry4nu2SdL0GZ2gkFsu6gBrB65Q@mail.gmail.com>

```
Stefan Beller <sbeller@google.com> writes:

> On Tue, Mar 1, 2016 at 12:42 PM, Joey Hess <id@joeyh.name> wrote:
>>         git init gitdir
>>         mkdir worktree
>>         cd worktree
>>         ln -s ../gitdir/.git .git
>>         git submodule add /any/git/repo sub
>>
>>         fatal: Could not chdir to '../../../sub': No such file or directory
>>
>> Fairly sure this is a bug..
>
> Which version(s) of Git do you use?

A more pertinent question may be which version of Git did the above
ever work, I guess.  We fairly liberally chdir around and I do not
think we deliberately avoid assuming that "cd .git && cd .." might
not come back to the original directory, for example, so I wouldn't
be surprised if it never worked.

```

## Joey Hess, 2016-03-01 23:14

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <20160301231422.GA3731@kitenet.net>
URL: https://gitlist.dev/e/20160301231422.GA3731%40kitenet.net
In-Reply-To: <CAGZ79kbV9y6nDuBgqLbzQ=xaroG_uF8RF6gqzk=unJ-9rrtvfw@mail.gmail.com>

```
Stefan Beller wrote:
> To elaborate on that: Starting in 2.7 parts of the submodule stuff
> has been rewritten in C, in 2.8 even more and there is more in flight for
>  > 2.8.
> 
> However your bug is also to be found in 2.6, which doesn't contain any
> recent rewrites, so it is a rather long standing bug, I would presume.

Yes, I saw it with 2.7.0, but I think the user who reported it was on
2.6.

> As a workaround for now:
> 
>     echo "gitdir: ../gitdir/.git" > .git

Not an option in our particular situation, unfortunately.

I wonder if the miscalculated ../../../somedir could cause git to access
files outside the git repos?

-- 
see shy jo

```

## Joey Hess, 2016-03-01 23:17

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <20160301231720.GB3731@kitenet.net>
URL: https://gitlist.dev/e/20160301231720.GB3731%40kitenet.net
In-Reply-To: <xmqq8u217tqa.fsf@gitster.mtv.corp.google.com>

```
Junio C Hamano wrote:
> A more pertinent question may be which version of Git did the above
> ever work, I guess.  We fairly liberally chdir around and I do not
> think we deliberately avoid assuming that "cd .git && cd .." might
> not come back to the original directory, for example, so I wouldn't
> be surprised if it never worked.

IIRC git used symlinks for .git in submodules before version 1.7.8, so I
guess that older versions supported that pretty well.

This one case is the only time I've seen a symlink for .git present a
problem so far.

-- 
see shy jo

```

## Jeff King, 2016-03-02 08:49

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <20160302084904.GA30295@sigill.intra.peff.net>
URL: https://gitlist.dev/e/20160302084904.GA30295%40sigill.intra.peff.net
In-Reply-To: <20160301231720.GB3731@kitenet.net>

```
On Tue, Mar 01, 2016 at 07:17:20PM -0400, Joey Hess wrote:

> Junio C Hamano wrote:
> > A more pertinent question may be which version of Git did the above
> > ever work, I guess.  We fairly liberally chdir around and I do not
> > think we deliberately avoid assuming that "cd .git && cd .." might
> > not come back to the original directory, for example, so I wouldn't
> > be surprised if it never worked.
> 
> IIRC git used symlinks for .git in submodules before version 1.7.8, so I
> guess that older versions supported that pretty well.
> 
> This one case is the only time I've seen a symlink for .git present a
> problem so far.

Fortunately you provided a simple reproduction case, so it is easy to
bisect. It did work in v1.7.8, and broke in d75219b (submodules: always
use a relative path from gitdir to work tree, 2012-03-04). Not
surprising, I guess. It presumably worked before only because we were
using absolute paths.

-Peff

```

## Stefan Beller, 2016-04-20 16:41

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <CAGZ79kbpyu34kz7gRgro-HZqNvpmRoCsyQatZRbxP19bk1gkfg@mail.gmail.com>
URL: https://gitlist.dev/e/CAGZ79kbpyu34kz7gRgro-HZqNvpmRoCsyQatZRbxP19bk1gkfg%40mail.gmail.com
In-Reply-To: <20160302084904.GA30295@sigill.intra.peff.net>

```
On Wed, Mar 2, 2016 at 12:49 AM, Jeff King <peff@peff.net> wrote:
> On Tue, Mar 01, 2016 at 07:17:20PM -0400, Joey Hess wrote:
>
>> Junio C Hamano wrote:
>> > A more pertinent question may be which version of Git did the above
>> > ever work, I guess.  We fairly liberally chdir around and I do not
>> > think we deliberately avoid assuming that "cd .git && cd .." might
>> > not come back to the original directory, for example, so I wouldn't
>> > be surprised if it never worked.
>>
>> IIRC git used symlinks for .git in submodules before version 1.7.8, so I
>> guess that older versions supported that pretty well.
>>
>> This one case is the only time I've seen a symlink for .git present a
>> problem so far.
>
> Fortunately you provided a simple reproduction case, so it is easy to
> bisect. It did work in v1.7.8, and broke in d75219b (submodules: always
> use a relative path from gitdir to work tree, 2012-03-04). Not
> surprising, I guess. It presumably worked before only because we were
> using absolute paths.

So I was looking into this bug again, as it was linked from another bug report.

fatal: Could not chdir to '../../../sub': No such file or directory

sounds like a path issue with the prefix thing.

Using the " echo "gitdir: ../gitdir/.git" > .git" workaround does still work,
I'll see if there is another way to fix it with actual links.


>
> -Peff
> --
> To unsubscribe from this list: send the line "unsubscribe git" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

```

## Stefan Beller, 2016-04-20 17:31

Subject: Re: bug: git submodule add fails when .git is a symlink
Message-ID: <CAGZ79kZ2A6c9H7C4xPXJ1Lmh1TaVy+VgcjxvKrgcJb0-4LRvhA@mail.gmail.com>
URL: https://gitlist.dev/e/CAGZ79kZ2A6c9H7C4xPXJ1Lmh1TaVy%2BVgcjxvKrgcJb0-4LRvhA%40mail.gmail.com
In-Reply-To: <CAGZ79kbpyu34kz7gRgro-HZqNvpmRoCsyQatZRbxP19bk1gkfg@mail.gmail.com>

```
On Wed, Apr 20, 2016 at 9:41 AM, Stefan Beller <sbeller@google.com> wrote:
> On Wed, Mar 2, 2016 at 12:49 AM, Jeff King <peff@peff.net> wrote:
>> On Tue, Mar 01, 2016 at 07:17:20PM -0400, Joey Hess wrote:
>>
>>> Junio C Hamano wrote:
>>> > A more pertinent question may be which version of Git did the above
>>> > ever work, I guess.  We fairly liberally chdir around and I do not
>>> > think we deliberately avoid assuming that "cd .git && cd .." might
>>> > not come back to the original directory, for example, so I wouldn't
>>> > be surprised if it never worked.
>>>
>>> IIRC git used symlinks for .git in submodules before version 1.7.8, so I
>>> guess that older versions supported that pretty well.
>>>
>>> This one case is the only time I've seen a symlink for .git present a
>>> problem so far.
>>
>> Fortunately you provided a simple reproduction case, so it is easy to
>> bisect. It did work in v1.7.8, and broke in d75219b (submodules: always
>> use a relative path from gitdir to work tree, 2012-03-04). Not
>> surprising, I guess. It presumably worked before only because we were
>> using absolute paths.
>
> So I was looking into this bug again, as it was linked from another bug report.
>
> fatal: Could not chdir to '../../../sub': No such file or directory
>
> sounds like a path issue with the prefix thing.
>
> Using the " echo "gitdir: ../gitdir/.git" > .git" workaround does still work,
> I'll see if there is another way to fix it with actual links.

So I debugged into that using a test case

test_expect_success 'submodules are not confused by linked gitdir' '
        git init gitdir &&
        mkdir worktree &&
        (
                cd worktree &&
                #echo "gitdir: ../gitdir/.git" >.git &&
                ln -s ../gitdir/.git .git &&
                test_pause &&
                git submodule add ../ sub &&
                test_pause
        ) &&
        test_pause &&
        git status
'

My observation: the error comes up in `git submodule add`,
which consists of 2 parts: the cloning and then the checkout.
The cloning works fine using the new "submodule--helper update-clone",
the checkout however breaks. So in your original test case you can go
into the submodule and run

    git checkout -f -q

and you'll get the error message

    fatal: Could not chdir to '../../../sub': No such file or directory

Looking at sub/.git:

    $ cat .git
    gitdir: ../.git/modules/sub
    $ ls ../.git/modules/sub
    HEAD  branches config description  hooks  info  logs objects
packed-refs  ref

so that gitlink of the submodule works just fine. The problem is `git checkout`
or any other core command (I tested with `git status`) doesn't like
the gitlink pointing to a directory which is symlinked.

I think the issue is a wrongly configured "core.worktree"
in gitdir/.git/modules/sub/config which contains the "../../../sub".

So I think the fix needs to be in the vicinity of
builtin/submodule--helper.c:module_clone
near the end of the function, where core.worktree is set.

Thanks,
Stefan


>
>
>>
>> -Peff
>> --
>> To unsubscribe from this list: send the line "unsubscribe git" in
>> the body of a message to majordomo@vger.kernel.org
>> More majordomo info at  http://vger.kernel.org/majordomo-info.html

```
