git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: git@vger.kernel.org,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>,
	Hariom verma <hariom18599@gmail.com>
Subject: Re: [PATCH] worktree: avoid dead-code in conditional
Date: Wed, 24 Jun 2020 14:20:12 -0700	[thread overview]
Message-ID: <xmqqsgek5fg3.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <20200624190541.5253-1-sunshine@sunshineco.com> (Eric Sunshine's message of "Wed, 24 Jun 2020 15:05:41 -0400")

Eric Sunshine <sunshine@sunshineco.com> writes:

> get_worktrees() retrieves a list of all worktrees associated with a
> repository, including the main worktree. The location of the main
> worktree is determined by get_main_worktree() which needs to handle
> three distinct cases for the main worktree after absolute-path
> conversion:
>
>     * <bare-repository>/.
>     * <main-worktree>/.git/. (when $CWD is .git)
>     * <main-worktree>/.git (when $CWD is any worktree)

It is unclear from the above but I would assume that you are talking
about the returned path from get_git_common_dir().

I can certainly understand why there needs two distinct cases
(i.e.. bare vs non-bare), but why is this codepath (or any caller of
get_git_common_dir()) forced to care about the two cases?

I wonder if the right "fix" to this instance, at the same time
preventing similar breakages in the future, is rather make sure
get_git_common_dir() not to return the redundant path with ".git/."
suffixed?  For that matter, I do not know why the bare case must
need "/." suffix.  There seem to be about a dozen callers of the
function, but don't some of them share a similar issue?  

Let's look at the other two grep hits from worktree.c

	strbuf_reset(&path);
	strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);

	worktree = xcalloc(1, sizeof(*worktree));
	worktree->path = strbuf_detach(&worktree_path, NULL);
	worktree->id = xstrdup(id);
	add_head_info(worktree);

done:
	strbuf_release(&path);
	strbuf_release(&worktree_path);
	return worktree;
}

This looks somewhat bogus.  "sturct strbuf path" is populated, but
is released without ever getting used, isn't it?  Am I grossly
misreading the code?

The other one

	strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
	dir = opendir(path.buf);
	strbuf_release(&path);
	if (dir) {
		while ((d = readdir(dir)) != NULL) {
		...

is a regular filesystem access, but it ends up opening the directory
with a path like "foo/.git/./worktrees", where we should be using a
more reasonable "foo/.git/worktrees" to access it.  The redundant
"/./" is not wrong per-se, but it looks sloppy to depend on "not
wrong per-se".

Puzzled.

  reply	other threads:[~2020-06-24 21:20 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-24 19:05 [PATCH] worktree: avoid dead-code in conditional Eric Sunshine
2020-06-24 21:20 ` Junio C Hamano [this message]
2020-06-24 23:00   ` Eric Sunshine
2020-06-25  0:38     ` Junio C Hamano

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=xmqqsgek5fg3.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=hariom18599@gmail.com \
    --cc=sunshine@sunshineco.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).