From: Erin Dahlgren <eedahlgren@gmail.com>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH] Simplify handling of setup_git_directory_gently() failure cases.
Date: Sat, 15 Dec 2018 17:05:01 -0800 [thread overview]
Message-ID: <CAP_Smy1q4kdZTX-38XvG47PA-HOWJZk=kmT4yS+swprC-5q4rw@mail.gmail.com> (raw)
In-Reply-To: <nycvar.QRO.7.76.6.1812141130180.43@tvgsbejvaqbjf.bet>
On Fri, Dec 14, 2018 at 2:32 AM Johannes Schindelin
<Johannes.Schindelin@gmx.de> wrote:
>
> Hi Erin,
>
> On Thu, 13 Dec 2018, Erin Dahlgren wrote:
>
> > setup_git_directory_gently() expects two types of failures to
> > discover a git directory (e.g. .git/):
> >
> > - GIT_DIR_HIT_CEILING: could not find a git directory in any
> > parent directories of the cwd.
> > - GIT_DIR_HIT_MOUNT_POINT: could not find a git directory in
> > any parent directories up to the mount point of the cwd.
> >
> > Both cases are handled in a similar way, but there are misleading
> > and unimportant differences. In both cases, setup_git_directory_gently()
> > should:
> >
> > - Die if we are not in a git repository. Otherwise:
> > - Set nongit_ok = 1, indicating that we are not in a git repository
> > but this is ok.
> > - Call strbuf_release() on any non-static struct strbufs that we
> > allocated.
> >
> > Before this change are two misleading additional behaviors:
> >
> > - GIT_DIR_HIT_CEILING: setup_nongit() changes to the cwd for no
> > apparent reason. We never had the chance to change directories
> > up to this point so chdir(current cwd) is pointless.
> > - GIT_DIR_HIT_MOUNT_POINT: strbuf_release() frees the buffer
> > of a static struct strbuf (cwd). This is unnecessary because the
> > struct is static so its buffer is always reachable. This is also
> > misleading because nowhere else in the function is this buffer
> > released.
> >
> > This change eliminates these two misleading additional behaviors and
> > deletes setup_nogit() because the code is clearer without it. The
> > result is that we can see clearly that GIT_DIR_HIT_CEILING and
> > GIT_DIR_HIT_MOUNT_POINT lead to the same behavior (ignoring the
> > different help messages).
> >
> > Thanks-to: Johannes Schindelin <johannes.schindelin@gmx.de>
> > Signed-off-by: Erin Dahlgren <eedahlgren@gmail.com>
>
> Thank you for working on this!
>
> > ---
> > setup.c | 34 +++++++++++++---------------------
> > 1 file changed, 13 insertions(+), 21 deletions(-)
>
> Nice! It's always good to see a code reduction with such a cleanup.
>
> Just one thing:
>
> > diff --git a/setup.c b/setup.c
> > index 1be5037..b441e39 100644
> > --- a/setup.c
> > +++ b/setup.c
> > @@ -831,16 +831,6 @@ static const char *setup_bare_git_dir(struct strbuf *cwd, int offset,
> > return NULL;
> > }
> >
> > -static const char *setup_nongit(const char *cwd, int *nongit_ok)
> > -{
> > - if (!nongit_ok)
> > - die(_("not a git repository (or any of the parent directories): %s"), DEFAULT_GIT_DIR_ENVIRONMENT);
> > - if (chdir(cwd))
> > - die_errno(_("cannot come back to cwd"));
> > - *nongit_ok = 1;
> > - return NULL;
> > -}
> > -
> > static dev_t get_device_or_die(const char *path, const char *prefix, int prefix_len)
> > {
> > struct stat buf;
> > @@ -1097,18 +1087,20 @@ const char *setup_git_directory_gently(int *nongit_ok)
> > prefix = setup_bare_git_dir(&cwd, dir.len, &repo_fmt, nongit_ok);
> > break;
> > case GIT_DIR_HIT_CEILING:
> > - prefix = setup_nongit(cwd.buf, nongit_ok);
> > - break;
> > + if (!nongit_ok)
> > + die(_("not a git repository (or any of the parent directories): %s"),
> > + DEFAULT_GIT_DIR_ENVIRONMENT);
> > + *nongit_ok = 1;
> > + strbuf_release(&dir);
> > + return NULL;
> > case GIT_DIR_HIT_MOUNT_POINT:
> > - if (nongit_ok) {
> > - *nongit_ok = 1;
> > - strbuf_release(&cwd);
> > - strbuf_release(&dir);
> > - return NULL;
> > - }
> > - die(_("not a git repository (or any parent up to mount point %s)\n"
> > - "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
> > - dir.buf);
> > + if (!nongit_ok)
> > + die(_("not a git repository (or any parent up to mount point %s)\n"
> > + "Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)."),
> > + dir.buf);
>
> This indentation would probably be better aligned with the first
> double-quote on the `die` line.
Hi Johannes,
No problem. Thanks for your time discussing and reviewing!
- Erin
>
> Otherwise: ACK!
>
> Thank you,
> Johannes
>
> > + *nongit_ok = 1;
> > + strbuf_release(&dir);
> > + return NULL;
> > default:
> > BUG("unhandled setup_git_directory_1() result");
> > }
> > --
> > 2.7.4
> >
> >
next prev parent reply other threads:[~2018-12-16 1:05 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-12-13 17:30 [PATCH] Simplify handling of setup_git_directory_gently() failure cases Erin Dahlgren
2018-12-14 10:32 ` Johannes Schindelin
2018-12-16 1:05 ` Erin Dahlgren [this message]
2018-12-16 1:05 ` [PATCH v2] " Erin Dahlgren
2018-12-18 12:35 ` Johannes Schindelin
2018-12-18 19:50 ` Erin Dahlgren
2018-12-18 17:54 ` Jeff King
2018-12-18 20:54 ` Erin Dahlgren
2018-12-19 15:59 ` Jeff King
2018-12-26 22:22 ` Junio C Hamano
2018-12-27 16:24 ` Jeff King
2018-12-27 23:46 ` Erin Dahlgren
2019-01-03 4:54 ` Jeff King
2018-12-27 23:36 ` [PATCH v3] " Erin Dahlgren
2019-01-03 5:14 ` Jeff King
2019-01-03 18:09 ` Junio C Hamano
2019-01-04 8:25 ` Jeff King
2019-01-05 16:57 ` Erin Dahlgren
2019-01-06 6:22 ` Jeff King
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAP_Smy1q4kdZTX-38XvG47PA-HOWJZk=kmT4yS+swprC-5q4rw@mail.gmail.com' \
--to=eedahlgren@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).