Skip to content

Commit

Permalink
checkout: retire --to option
Browse files Browse the repository at this point in the history 
Now that "git worktree add" has achieved user-facing feature-parity with
"git checkout --to", retire the latter.

Move the actual linked worktree creation functionality,
prepare_linked_checkout() and its helpers, verbatim from checkout.c to
worktree.c.

This effectively reverts changes to checkout.c by 529fef2 (checkout:
support checking out into a new working directory, 2014-11-30) with the
exception of merge_working_tree() and switch_branches() which still
require specialized knowledge that a the checkout is occurring in a
newly-created linked worktree (signaled to them by the private
GIT_CHECKOUT_NEW_WORKTREE environment variable).

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Eric Sunshine authored and Junio C Hamano committed Jul 6, 2015
1 parent f194b1e commit b979d95
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 173 deletions.
7 changes: 0 additions & 7 deletions Documentation/git-checkout.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -225,13 +225,6 @@ This means that you can use `git checkout -p` to selectively discard
edits from your current working tree. See the ``Interactive Mode''
section of linkgit:git-add[1] to learn how to operate the `--patch` mode.

--to=<path>::
Check out a branch in a separate working directory at
`<path>`. A new working directory is linked to the current
repository, sharing everything except working directory
specific files such as HEAD, index, etc. See
linkgit:git-worktree[1] for a description of linked worktrees.

--ignore-other-worktrees::
`git checkout` refuses when the wanted ref is already checked
out by another worktree. This option makes it check the ref
Expand Down
161 changes: 1 addition & 160 deletions builtin/checkout.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
#include "ll-merge.h"
#include "resolve-undo.h"
#include "submodule.h"
#include "argv-array.h"
#include "sigchain.h"

static const char * const checkout_usage[] = {
N_("git checkout [options] <branch>"),
Expand Down Expand Up @@ -51,8 +49,6 @@ struct checkout_opts {
struct pathspec pathspec;
struct tree *source_tree;

const char *new_worktree;
const char **saved_argv;
int new_worktree_mode;
};

Expand Down Expand Up @@ -255,9 +251,6 @@ static int checkout_paths(const struct checkout_opts *opts,
die(_("Cannot update paths and switch to branch '%s' at the same time."),
opts->new_branch);

if (opts->new_worktree)
die(_("'%s' cannot be used with updating paths"), "--to");

if (opts->patch_mode)
return run_add_interactive(revision, "--patch=checkout",
&opts->pathspec);
Expand Down Expand Up @@ -825,142 +818,6 @@ static int switch_branches(const struct checkout_opts *opts,
return ret || writeout_error;
}

static char *junk_work_tree;
static char *junk_git_dir;
static int is_junk;
static pid_t junk_pid;

static void remove_junk(void)
{
struct strbuf sb = STRBUF_INIT;
if (!is_junk || getpid() != junk_pid)
return;
if (junk_git_dir) {
strbuf_addstr(&sb, junk_git_dir);
remove_dir_recursively(&sb, 0);
strbuf_reset(&sb);
}
if (junk_work_tree) {
strbuf_addstr(&sb, junk_work_tree);
remove_dir_recursively(&sb, 0);
}
strbuf_release(&sb);
}

static void remove_junk_on_signal(int signo)
{
remove_junk();
sigchain_pop(signo);
raise(signo);
}

static int prepare_linked_checkout(const char *path, const char **child_argv)
{
struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT;
struct strbuf sb = STRBUF_INIT;
const char *name;
struct stat st;
struct child_process cp;
int counter = 0, len, ret;
unsigned char rev[20];

if (file_exists(path) && !is_empty_dir(path))
die(_("'%s' already exists"), path);

len = strlen(path);
while (len && is_dir_sep(path[len - 1]))
len--;

for (name = path + len - 1; name > path; name--)
if (is_dir_sep(*name)) {
name++;
break;
}
strbuf_addstr(&sb_repo,
git_path("worktrees/%.*s", (int)(path + len - name), name));
len = sb_repo.len;
if (safe_create_leading_directories_const(sb_repo.buf))
die_errno(_("could not create leading directories of '%s'"),
sb_repo.buf);
while (!stat(sb_repo.buf, &st)) {
counter++;
strbuf_setlen(&sb_repo, len);
strbuf_addf(&sb_repo, "%d", counter);
}
name = strrchr(sb_repo.buf, '/') + 1;

junk_pid = getpid();
atexit(remove_junk);
sigchain_push_common(remove_junk_on_signal);

if (mkdir(sb_repo.buf, 0777))
die_errno(_("could not create directory of '%s'"), sb_repo.buf);
junk_git_dir = xstrdup(sb_repo.buf);
is_junk = 1;

/*
* lock the incomplete repo so prune won't delete it, unlock
* after the preparation is over.
*/
strbuf_addf(&sb, "%s/locked", sb_repo.buf);
write_file(sb.buf, 1, "initializing\n");

strbuf_addf(&sb_git, "%s/.git", path);
if (safe_create_leading_directories_const(sb_git.buf))
die_errno(_("could not create leading directories of '%s'"),
sb_git.buf);
junk_work_tree = xstrdup(path);

strbuf_reset(&sb);
strbuf_addf(&sb, "%s/gitdir", sb_repo.buf);
write_file(sb.buf, 1, "%s\n", real_path(sb_git.buf));
write_file(sb_git.buf, 1, "gitdir: %s/worktrees/%s\n",
real_path(get_git_common_dir()), name);
/*
* This is to keep resolve_ref() happy. We need a valid HEAD
* or is_git_directory() will reject the directory. Moreover, HEAD
* in the new worktree must resolve to the same value as HEAD in
* the current tree since the command invoked to populate the new
* worktree will be handed the branch/ref specified by the user.
* For instance, if the user asks for the new worktree to be based
* at HEAD~5, then the resolved HEAD~5 in the new worktree must
* match the resolved HEAD~5 in the current tree in order to match
* the user's expectation.
*/
if (!resolve_ref_unsafe("HEAD", 0, rev, NULL))
die(_("unable to resolve HEAD"));
strbuf_reset(&sb);
strbuf_addf(&sb, "%s/HEAD", sb_repo.buf);
write_file(sb.buf, 1, "%s\n", sha1_to_hex(rev));
strbuf_reset(&sb);
strbuf_addf(&sb, "%s/commondir", sb_repo.buf);
write_file(sb.buf, 1, "../..\n");

fprintf_ln(stderr, _("Enter %s (identifier %s)"), path, name);

setenv("GIT_CHECKOUT_NEW_WORKTREE", "1", 1);
setenv(GIT_DIR_ENVIRONMENT, sb_git.buf, 1);
setenv(GIT_WORK_TREE_ENVIRONMENT, path, 1);
memset(&cp, 0, sizeof(cp));
cp.git_cmd = 1;
cp.argv = child_argv;
ret = run_command(&cp);
if (!ret) {
is_junk = 0;
free(junk_work_tree);
free(junk_git_dir);
junk_work_tree = NULL;
junk_git_dir = NULL;
}
strbuf_reset(&sb);
strbuf_addf(&sb, "%s/locked", sb_repo.buf);
unlink_or_warn(sb.buf);
strbuf_release(&sb);
strbuf_release(&sb_repo);
strbuf_release(&sb_git);
return ret;
}

static int git_checkout_config(const char *var, const char *value, void *cb)
{
if (!strcmp(var, "diff.ignoresubmodules")) {
Expand Down Expand Up @@ -1299,13 +1156,6 @@ static int checkout_branch(struct checkout_opts *opts,
free(head_ref);
}

if (opts->new_worktree) {
if (!new->commit)
die(_("no branch specified"));
return prepare_linked_checkout(opts->new_worktree,
opts->saved_argv);
}

if (!new->commit && opts->new_branch) {
unsigned char rev[20];
int flag;
Expand Down Expand Up @@ -1348,8 +1198,6 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
N_("do not limit pathspecs to sparse entries only")),
OPT_HIDDEN_BOOL(0, "guess", &dwim_new_local_branch,
N_("second guess 'git checkout no-such-branch'")),
OPT_FILENAME(0, "to", &opts.new_worktree,
N_("check a branch out in a separate working directory")),
OPT_BOOL(0, "ignore-other-worktrees", &opts.ignore_other_worktrees,
N_("do not check if another worktree is holding the given ref")),
OPT_END(),
Expand All @@ -1360,9 +1208,6 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
opts.overwrite_ignore = 1;
opts.prefix = prefix;

opts.saved_argv = xmalloc(sizeof(const char *) * (argc + 2));
memcpy(opts.saved_argv, argv, sizeof(const char *) * (argc + 1));

gitmodules_config();
git_config(git_checkout_config, &opts);

Expand All @@ -1371,13 +1216,9 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
argc = parse_options(argc, argv, prefix, options, checkout_usage,
PARSE_OPT_KEEP_DASHDASH);

/* recursive execution from checkout_new_worktree() */
opts.new_worktree_mode = getenv("GIT_CHECKOUT_NEW_WORKTREE") != NULL;
if (opts.new_worktree_mode)
opts.new_worktree = NULL;

if (!opts.new_worktree)
setup_work_tree();
setup_work_tree();

if (conflict_style) {
opts.merge = 1; /* implied */
Expand Down
Loading

0 comments on commit b979d95

Please sign in to comment.