From: Shourya Shukla <shouryashukla.oo@gmail.com>
To: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
Cc: gitster@pobox.com, git@vger.kernel.org,
christian.couder@gmail.com, johannes.schindelin@gmx.de,
liu.denton@gmail.com
Subject: Re: [GSoC][PATCH] submodule: port submodule subcommand 'add' from shell to C
Date: Wed, 2 Sep 2020 17:34:22 +0530 [thread overview]
Message-ID: <20200902120422.GA28650@konoha> (raw)
In-Reply-To: <31e40c63bbac03d261ac6f46a0d2f6ae90a21038.camel@gmail.com>
On 02/09 02:05, Kaartic Sivaraam wrote:
> On Mon, 2020-08-31 at 18:34 +0530, Shourya Shukla wrote:
> > On 31/08 01:28, Kaartic Sivaraam wrote:
> >
> > This is what I have done finally:
> > ---
> > if (read_cache() < 0)
> > die(_("index file corrupt"));
> >
> > if (!force) {
> > if (cache_file_exists(path, strlen(path), ignore_case) ||
> > cache_dir_exists(path, strlen(path)))
> > die(_("'%s' already exists in the index"), path);
> > } else {
> > int cache_pos = cache_name_pos(path, strlen(path));
> > struct cache_entry *ce = the_index.cache[cache_pos];
> > if (cache_pos >= 0 && !S_ISGITLINK(ce->ce_mode))
> > die(_("'%s' already exists in the index and is not a "
> > "submodule"), path);
> > }
> > ---
> >
> > I did not put the 'cache_pos >= 0' at the start since I thought that it
> > will unnecessarily increase an indentation level. Since we are using
> > 'cache_{file,dir}_exists' in the first check and 'cache_name_pos()' in
> > the second, the placement of check at another indentation level would be
> > unnecessary. What do you think about this?
> >
>
> Interestingly. 'cache_dir_exists' seems to work as expected only when
> the global ignore_case whose value seems to depend on core.ignorecase.
> So, we can't just rely on 'cache_dir_exists to identify a directory
> that has tracked contents. Apparently, the 'directory_exists_in_index'
> in 'dir.c' seems to have the code that we want here (which is also the
> only user of 'index_dir_exists'; the function for which
> 'cache_dir_exists' is a convenience wrapper.
I think both 'cache_{dir,file}_exists()' depend on 'core.ignorecase'
though I am not able to confirm this for 'cache_dir_exists()'. Where
exactly does this happen for the function? The function you mention
seems perfect to me, though, we will also have to make the enum
'exist_status' visible. Will that be fine? The final output will be:
---
if (!force) {
if (directory_exists_in_index(&the_index, path, strlen(path)))
die(_("'%s' already exists in the index"), path);
} else {
int cache_pos = cache_name_pos(path, strlen(path));
struct cache_entry *ce = the_index.cache[cache_pos];
if (cache_pos >= 0 && !S_ISGITLINK(ce->ce_mode))
die(_("'%s' already exists in the index and is not a "
"submodule"), path);
}
---
And obviously an extra commit changing the visibility of the function
and the enum.
> > > This is more close to what the shell version did but misses one case
> > > which might or might not be covered by the test suite[1]. The case when
> > > path is a directory that has tracked contents. In the shell version we
> > > would get:
> > >
> > > $ git submodule add ../git-crypt/ builtin
> > > 'builtin' already exists in the index
> > > $ git submodule add --force ../git-crypt/ builtin
> > > 'builtin' already exists in the index and is not a submodule
> > >
> > > In the C version with the above snippet we get:
> > >
> > > $ git submodule add --force ../git-crypt/ builtin
> > > fatal: 'builtin' does not have a commit checked out
> > > $ git submodule add ../git-crypt/ builtin
> > > fatal: 'builtin' does not have a commit checked out
> > >
> > > That's not appropriate and should be fixed. I believe we could do
> > > something with `cache_dir_exists` to fix this.
> > >
> > >
> > > Footnote
> > > ===
> > >
> > > [1]: If it's not covered already, it might be a good idea to add a test
> > > for the above case.
> >
> > Like Junio said, we do not care if it is a file or a directory of any
> > sorts, we will give the error if it already exists. Therefore, even if
> > it is an untracked or a tracked one, it should not matter to us. Hence
> > testing for it may not be necessary is what I feel. Why should we test
> > it?
>
> I'm guessing you misunderstood. A few things:
>
> - We only care about tracked contents for the case in hand.
>
> - Identifying whether a given path corresponds to a directory
> which has tracked contents is tricky. Neither 'cache_name_pos'
> nor 'cache_file_exists' handle this. 'cache_dir_exists' is also
> not very useful as mentioned above.
>
> So, we do have to take care when handling that case as Junio pointed
> out.
I still do not understand this case. Let's say this was our
superproject:
.gitmodules .git/ a.txt dir1/
And we did:
$ git submodule add <url> dir1/
Now, at this point, how does it matter if 'dir1/' has tracked content or
not right? A directory exists with that name and now we do not add the
SM to that path.
next prev parent reply other threads:[~2020-09-02 12:04 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-24 9:03 [GSoC][PATCH] submodule: port submodule subcommand 'add' from shell to C Shourya Shukla
2020-08-24 18:35 ` Junio C Hamano
2020-08-24 20:30 ` Kaartic Sivaraam
2020-08-24 20:46 ` Junio C Hamano
2020-08-26 9:27 ` Shourya Shukla
2020-08-26 10:54 ` Kaartic Sivaraam
2020-08-26 9:15 ` Shourya Shukla
2020-08-30 19:58 ` Kaartic Sivaraam
2020-08-31 13:04 ` Shourya Shukla
2020-09-01 20:35 ` Kaartic Sivaraam
2020-09-02 12:04 ` Shourya Shukla [this message]
2020-09-03 8:46 ` Kaartic Sivaraam
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200902120422.GA28650@konoha \
--to=shouryashukla.oo@gmail.com \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=johannes.schindelin@gmx.de \
--cc=kaartic.sivaraam@gmail.com \
--cc=liu.denton@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).