8 #include "parse-options.h"
12 #include "run-command.h"
15 #include "submodule.h"
20 #define BUILTIN_WORKTREE_ADD_USAGE \
21 N_("git worktree add [-f] [--detach] [--checkout] [--lock [--reason <string>]]\n" \
22 " [-b <new-branch>] <path> [<commit-ish>]")
23 #define BUILTIN_WORKTREE_LIST_USAGE \
24 N_("git worktree list [-v | --porcelain [-z]]")
25 #define BUILTIN_WORKTREE_LOCK_USAGE \
26 N_("git worktree lock [--reason <string>] <worktree>")
27 #define BUILTIN_WORKTREE_MOVE_USAGE \
28 N_("git worktree move <worktree> <new-path>")
29 #define BUILTIN_WORKTREE_PRUNE_USAGE \
30 N_("git worktree prune [-n] [-v] [--expire <expire>]")
31 #define BUILTIN_WORKTREE_REMOVE_USAGE \
32 N_("git worktree remove [-f] <worktree>")
33 #define BUILTIN_WORKTREE_REPAIR_USAGE \
34 N_("git worktree repair [<path>...]")
35 #define BUILTIN_WORKTREE_UNLOCK_USAGE \
36 N_("git worktree unlock <worktree>")
38 static const char * const git_worktree_usage
[] = {
39 BUILTIN_WORKTREE_ADD_USAGE
,
40 BUILTIN_WORKTREE_LIST_USAGE
,
41 BUILTIN_WORKTREE_LOCK_USAGE
,
42 BUILTIN_WORKTREE_MOVE_USAGE
,
43 BUILTIN_WORKTREE_PRUNE_USAGE
,
44 BUILTIN_WORKTREE_REMOVE_USAGE
,
45 BUILTIN_WORKTREE_REPAIR_USAGE
,
46 BUILTIN_WORKTREE_UNLOCK_USAGE
,
50 static const char * const git_worktree_add_usage
[] = {
51 BUILTIN_WORKTREE_ADD_USAGE
,
55 static const char * const git_worktree_list_usage
[] = {
56 BUILTIN_WORKTREE_LIST_USAGE
,
60 static const char * const git_worktree_lock_usage
[] = {
61 BUILTIN_WORKTREE_LOCK_USAGE
,
65 static const char * const git_worktree_move_usage
[] = {
66 BUILTIN_WORKTREE_MOVE_USAGE
,
70 static const char * const git_worktree_prune_usage
[] = {
71 BUILTIN_WORKTREE_PRUNE_USAGE
,
75 static const char * const git_worktree_remove_usage
[] = {
76 BUILTIN_WORKTREE_REMOVE_USAGE
,
80 static const char * const git_worktree_repair_usage
[] = {
81 BUILTIN_WORKTREE_REPAIR_USAGE
,
85 static const char * const git_worktree_unlock_usage
[] = {
86 BUILTIN_WORKTREE_UNLOCK_USAGE
,
95 const char *keep_locked
;
100 static int guess_remote
;
101 static timestamp_t expire
;
103 static int git_worktree_config(const char *var
, const char *value
, void *cb
)
105 if (!strcmp(var
, "worktree.guessremote")) {
106 guess_remote
= git_config_bool(var
, value
);
110 return git_default_config(var
, value
, cb
);
113 static int delete_git_dir(const char *id
)
115 struct strbuf sb
= STRBUF_INIT
;
118 strbuf_addstr(&sb
, git_common_path("worktrees/%s", id
));
119 ret
= remove_dir_recursively(&sb
, 0);
120 if (ret
< 0 && errno
== ENOTDIR
)
121 ret
= unlink(sb
.buf
);
123 error_errno(_("failed to delete '%s'"), sb
.buf
);
128 static void delete_worktrees_dir_if_empty(void)
130 rmdir(git_path("worktrees")); /* ignore failed removal */
133 static void prune_worktree(const char *id
, const char *reason
)
135 if (show_only
|| verbose
)
136 fprintf_ln(stderr
, _("Removing %s/%s: %s"), "worktrees", id
, reason
);
141 static int prune_cmp(const void *a
, const void *b
)
143 const struct string_list_item
*x
= a
;
144 const struct string_list_item
*y
= b
;
147 if ((c
= fspathcmp(x
->string
, y
->string
)))
150 * paths same; prune_dupes() removes all but the first worktree entry
151 * having the same path, so sort main worktree ('util' is NULL) above
152 * linked worktrees ('util' not NULL) since main worktree can't be
159 /* paths same; sort by .git/worktrees/<id> */
160 return strcmp(x
->util
, y
->util
);
163 static void prune_dups(struct string_list
*l
)
167 QSORT(l
->items
, l
->nr
, prune_cmp
);
168 for (i
= 1; i
< l
->nr
; i
++) {
169 if (!fspathcmp(l
->items
[i
].string
, l
->items
[i
- 1].string
))
170 prune_worktree(l
->items
[i
].util
, "duplicate entry");
174 static void prune_worktrees(void)
176 struct strbuf reason
= STRBUF_INIT
;
177 struct strbuf main_path
= STRBUF_INIT
;
178 struct string_list kept
= STRING_LIST_INIT_DUP
;
179 DIR *dir
= opendir(git_path("worktrees"));
183 while ((d
= readdir_skip_dot_and_dotdot(dir
)) != NULL
) {
185 strbuf_reset(&reason
);
186 if (should_prune_worktree(d
->d_name
, &reason
, &path
, expire
))
187 prune_worktree(d
->d_name
, reason
.buf
);
189 string_list_append_nodup(&kept
, path
)->util
= xstrdup(d
->d_name
);
193 strbuf_add_absolute_path(&main_path
, get_git_common_dir());
194 /* massage main worktree absolute path to match 'gitdir' content */
195 strbuf_strip_suffix(&main_path
, "/.");
196 string_list_append_nodup(&kept
, strbuf_detach(&main_path
, NULL
));
198 string_list_clear(&kept
, 1);
201 delete_worktrees_dir_if_empty();
202 strbuf_release(&reason
);
205 static int prune(int ac
, const char **av
, const char *prefix
)
207 struct option options
[] = {
208 OPT__DRY_RUN(&show_only
, N_("do not remove, show only")),
209 OPT__VERBOSE(&verbose
, N_("report pruned working trees")),
210 OPT_EXPIRY_DATE(0, "expire", &expire
,
211 N_("expire working trees older than <time>")),
216 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_prune_usage
,
219 usage_with_options(git_worktree_prune_usage
, options
);
224 static char *junk_work_tree
;
225 static char *junk_git_dir
;
227 static pid_t junk_pid
;
229 static void remove_junk(void)
231 struct strbuf sb
= STRBUF_INIT
;
232 if (!is_junk
|| getpid() != junk_pid
)
235 strbuf_addstr(&sb
, junk_git_dir
);
236 remove_dir_recursively(&sb
, 0);
239 if (junk_work_tree
) {
240 strbuf_addstr(&sb
, junk_work_tree
);
241 remove_dir_recursively(&sb
, 0);
246 static void remove_junk_on_signal(int signo
)
253 static const char *worktree_basename(const char *path
, int *olen
)
259 while (len
&& is_dir_sep(path
[len
- 1]))
262 for (name
= path
+ len
- 1; name
> path
; name
--)
263 if (is_dir_sep(*name
)) {
272 /* check that path is viable location for worktree */
273 static void check_candidate_path(const char *path
,
275 struct worktree
**worktrees
,
281 if (file_exists(path
) && !is_empty_dir(path
))
282 die(_("'%s' already exists"), path
);
284 wt
= find_worktree_by_path(worktrees
, path
);
288 locked
= !!worktree_lock_reason(wt
);
289 if ((!locked
&& force
) || (locked
&& force
> 1)) {
290 if (delete_git_dir(wt
->id
))
291 die(_("unusable worktree destination '%s'"), path
);
296 die(_("'%s' is a missing but locked worktree;\nuse '%s -f -f' to override, or 'unlock' and 'prune' or 'remove' to clear"), path
, cmd
);
298 die(_("'%s' is a missing but already registered worktree;\nuse '%s -f' to override, or 'prune' or 'remove' to clear"), path
, cmd
);
301 static void copy_sparse_checkout(const char *worktree_git_dir
)
303 char *from_file
= git_pathdup("info/sparse-checkout");
304 char *to_file
= xstrfmt("%s/info/sparse-checkout", worktree_git_dir
);
306 if (file_exists(from_file
)) {
307 if (safe_create_leading_directories(to_file
) ||
308 copy_file(to_file
, from_file
, 0666))
309 error(_("failed to copy '%s' to '%s'; sparse-checkout may not work correctly"),
317 static void copy_filtered_worktree_config(const char *worktree_git_dir
)
319 char *from_file
= git_pathdup("config.worktree");
320 char *to_file
= xstrfmt("%s/config.worktree", worktree_git_dir
);
322 if (file_exists(from_file
)) {
323 struct config_set cs
= { { 0 } };
324 const char *core_worktree
;
327 if (safe_create_leading_directories(to_file
) ||
328 copy_file(to_file
, from_file
, 0666)) {
329 error(_("failed to copy worktree config from '%s' to '%s'"),
331 goto worktree_copy_cleanup
;
334 git_configset_init(&cs
);
335 git_configset_add_file(&cs
, from_file
);
337 if (!git_configset_get_bool(&cs
, "core.bare", &bare
) &&
339 git_config_set_multivar_in_file_gently(
340 to_file
, "core.bare", NULL
, "true", 0))
341 error(_("failed to unset '%s' in '%s'"),
342 "core.bare", to_file
);
343 if (!git_configset_get_value(&cs
, "core.worktree", &core_worktree
) &&
344 git_config_set_in_file_gently(to_file
,
345 "core.worktree", NULL
))
346 error(_("failed to unset '%s' in '%s'"),
347 "core.worktree", to_file
);
349 git_configset_clear(&cs
);
352 worktree_copy_cleanup
:
357 static int checkout_worktree(const struct add_opts
*opts
,
358 struct strvec
*child_env
)
360 struct child_process cp
= CHILD_PROCESS_INIT
;
362 strvec_pushl(&cp
.args
, "reset", "--hard", "--no-recurse-submodules", NULL
);
364 strvec_push(&cp
.args
, "--quiet");
365 strvec_pushv(&cp
.env
, child_env
->v
);
366 return run_command(&cp
);
369 static int add_worktree(const char *path
, const char *refname
,
370 const struct add_opts
*opts
)
372 struct strbuf sb_git
= STRBUF_INIT
, sb_repo
= STRBUF_INIT
;
373 struct strbuf sb
= STRBUF_INIT
, realpath
= STRBUF_INIT
;
375 struct child_process cp
= CHILD_PROCESS_INIT
;
376 struct strvec child_env
= STRVEC_INIT
;
377 unsigned int counter
= 0;
379 struct strbuf symref
= STRBUF_INIT
;
380 struct commit
*commit
= NULL
;
382 struct strbuf sb_name
= STRBUF_INIT
;
383 struct worktree
**worktrees
;
385 worktrees
= get_worktrees();
386 check_candidate_path(path
, opts
->force
, worktrees
, "add");
387 free_worktrees(worktrees
);
390 /* is 'refname' a branch or commit? */
391 if (!opts
->detach
&& !strbuf_check_branch_ref(&symref
, refname
) &&
392 ref_exists(symref
.buf
)) {
395 die_if_checked_out(symref
.buf
, 0);
397 commit
= lookup_commit_reference_by_name(refname
);
399 die(_("invalid reference: %s"), refname
);
401 name
= worktree_basename(path
, &len
);
402 strbuf_add(&sb
, name
, path
+ len
- name
);
403 sanitize_refname_component(sb
.buf
, &sb_name
);
405 BUG("How come '%s' becomes empty after sanitization?", sb
.buf
);
408 git_path_buf(&sb_repo
, "worktrees/%s", name
);
410 if (safe_create_leading_directories_const(sb_repo
.buf
))
411 die_errno(_("could not create leading directories of '%s'"),
414 while (mkdir(sb_repo
.buf
, 0777)) {
416 if ((errno
!= EEXIST
) || !counter
/* overflow */)
417 die_errno(_("could not create directory of '%s'"),
419 strbuf_setlen(&sb_repo
, len
);
420 strbuf_addf(&sb_repo
, "%d", counter
);
422 name
= strrchr(sb_repo
.buf
, '/') + 1;
426 sigchain_push_common(remove_junk_on_signal
);
428 junk_git_dir
= xstrdup(sb_repo
.buf
);
432 * lock the incomplete repo so prune won't delete it, unlock
433 * after the preparation is over.
435 strbuf_addf(&sb
, "%s/locked", sb_repo
.buf
);
436 if (opts
->keep_locked
)
437 write_file(sb
.buf
, "%s", opts
->keep_locked
);
439 write_file(sb
.buf
, _("initializing"));
441 strbuf_addf(&sb_git
, "%s/.git", path
);
442 if (safe_create_leading_directories_const(sb_git
.buf
))
443 die_errno(_("could not create leading directories of '%s'"),
445 junk_work_tree
= xstrdup(path
);
448 strbuf_addf(&sb
, "%s/gitdir", sb_repo
.buf
);
449 strbuf_realpath(&realpath
, sb_git
.buf
, 1);
450 write_file(sb
.buf
, "%s", realpath
.buf
);
451 strbuf_realpath(&realpath
, get_git_common_dir(), 1);
452 write_file(sb_git
.buf
, "gitdir: %s/worktrees/%s",
455 * This is to keep resolve_ref() happy. We need a valid HEAD
456 * or is_git_directory() will reject the directory. Any value which
457 * looks like an object ID will do since it will be immediately
458 * replaced by the symbolic-ref or update-ref invocation in the new
462 strbuf_addf(&sb
, "%s/HEAD", sb_repo
.buf
);
463 write_file(sb
.buf
, "%s", oid_to_hex(null_oid()));
465 strbuf_addf(&sb
, "%s/commondir", sb_repo
.buf
);
466 write_file(sb
.buf
, "../..");
469 * If the current worktree has sparse-checkout enabled, then copy
470 * the sparse-checkout patterns from the current worktree.
472 if (core_apply_sparse_checkout
)
473 copy_sparse_checkout(sb_repo
.buf
);
476 * If we are using worktree config, then copy all current config
477 * values from the current worktree into the new one, that way the
478 * new worktree behaves the same as this one.
480 if (repository_format_worktree_config
)
481 copy_filtered_worktree_config(sb_repo
.buf
);
483 strvec_pushf(&child_env
, "%s=%s", GIT_DIR_ENVIRONMENT
, sb_git
.buf
);
484 strvec_pushf(&child_env
, "%s=%s", GIT_WORK_TREE_ENVIRONMENT
, path
);
488 strvec_pushl(&cp
.args
, "update-ref", "HEAD",
489 oid_to_hex(&commit
->object
.oid
), NULL
);
491 strvec_pushl(&cp
.args
, "symbolic-ref", "HEAD",
494 strvec_push(&cp
.args
, "--quiet");
497 strvec_pushv(&cp
.env
, child_env
.v
);
498 ret
= run_command(&cp
);
502 if (opts
->checkout
&&
503 (ret
= checkout_worktree(opts
, &child_env
)))
507 FREE_AND_NULL(junk_work_tree
);
508 FREE_AND_NULL(junk_git_dir
);
511 if (ret
|| !opts
->keep_locked
) {
513 strbuf_addf(&sb
, "%s/locked", sb_repo
.buf
);
514 unlink_or_warn(sb
.buf
);
518 * Hook failure does not warrant worktree deletion, so run hook after
519 * is_junk is cleared, but do return appropriate code when hook fails.
521 if (!ret
&& opts
->checkout
) {
522 struct run_hooks_opt opt
= RUN_HOOKS_OPT_INIT
;
524 strvec_pushl(&opt
.env
, "GIT_DIR", "GIT_WORK_TREE", NULL
);
525 strvec_pushl(&opt
.args
,
526 oid_to_hex(null_oid()),
527 oid_to_hex(&commit
->object
.oid
),
532 ret
= run_hooks_opt("post-checkout", &opt
);
535 strvec_clear(&child_env
);
537 strbuf_release(&symref
);
538 strbuf_release(&sb_repo
);
539 strbuf_release(&sb_git
);
540 strbuf_release(&sb_name
);
541 strbuf_release(&realpath
);
545 static void print_preparing_worktree_line(int detach
,
547 const char *new_branch
,
548 int force_new_branch
)
550 if (force_new_branch
) {
551 struct commit
*commit
= lookup_commit_reference_by_name(new_branch
);
553 fprintf_ln(stderr
, _("Preparing worktree (new branch '%s')"), new_branch
);
555 fprintf_ln(stderr
, _("Preparing worktree (resetting branch '%s'; was at %s)"),
557 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
558 } else if (new_branch
) {
559 fprintf_ln(stderr
, _("Preparing worktree (new branch '%s')"), new_branch
);
561 struct strbuf s
= STRBUF_INIT
;
562 if (!detach
&& !strbuf_check_branch_ref(&s
, branch
) &&
564 fprintf_ln(stderr
, _("Preparing worktree (checking out '%s')"),
567 struct commit
*commit
= lookup_commit_reference_by_name(branch
);
569 die(_("invalid reference: %s"), branch
);
570 fprintf_ln(stderr
, _("Preparing worktree (detached HEAD %s)"),
571 find_unique_abbrev(&commit
->object
.oid
, DEFAULT_ABBREV
));
577 static const char *dwim_branch(const char *path
, const char **new_branch
)
581 const char *s
= worktree_basename(path
, &n
);
582 const char *branchname
= xstrndup(s
, n
);
583 struct strbuf ref
= STRBUF_INIT
;
587 branch_exists
= !strbuf_check_branch_ref(&ref
, branchname
) &&
589 strbuf_release(&ref
);
593 *new_branch
= branchname
;
595 struct object_id oid
;
597 unique_tracking_name(*new_branch
, &oid
, NULL
);
603 static int add(int ac
, const char **av
, const char *prefix
)
605 struct add_opts opts
;
606 const char *new_branch_force
= NULL
;
609 const char *new_branch
= NULL
;
610 const char *opt_track
= NULL
;
611 const char *lock_reason
= NULL
;
613 struct option options
[] = {
614 OPT__FORCE(&opts
.force
,
615 N_("checkout <branch> even if already checked out in other worktree"),
616 PARSE_OPT_NOCOMPLETE
),
617 OPT_STRING('b', NULL
, &new_branch
, N_("branch"),
618 N_("create a new branch")),
619 OPT_STRING('B', NULL
, &new_branch_force
, N_("branch"),
620 N_("create or reset a branch")),
621 OPT_BOOL('d', "detach", &opts
.detach
, N_("detach HEAD at named commit")),
622 OPT_BOOL(0, "checkout", &opts
.checkout
, N_("populate the new working tree")),
623 OPT_BOOL(0, "lock", &keep_locked
, N_("keep the new working tree locked")),
624 OPT_STRING(0, "reason", &lock_reason
, N_("string"),
625 N_("reason for locking")),
626 OPT__QUIET(&opts
.quiet
, N_("suppress progress reporting")),
627 OPT_PASSTHRU(0, "track", &opt_track
, NULL
,
628 N_("set up tracking mode (see git-branch(1))"),
629 PARSE_OPT_NOARG
| PARSE_OPT_OPTARG
),
630 OPT_BOOL(0, "guess-remote", &guess_remote
,
631 N_("try to match the new branch name with a remote-tracking branch")),
636 memset(&opts
, 0, sizeof(opts
));
638 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_add_usage
, 0);
639 if (!!opts
.detach
+ !!new_branch
+ !!new_branch_force
> 1)
640 die(_("options '%s', '%s', and '%s' cannot be used together"), "-b", "-B", "--detach");
641 if (lock_reason
&& !keep_locked
)
642 die(_("the option '%s' requires '%s'"), "--reason", "--lock");
644 opts
.keep_locked
= lock_reason
;
645 else if (keep_locked
)
646 opts
.keep_locked
= _("added with --lock");
648 if (ac
< 1 || ac
> 2)
649 usage_with_options(git_worktree_add_usage
, options
);
651 path
= prefix_filename(prefix
, av
[0]);
652 branch
= ac
< 2 ? "HEAD" : av
[1];
654 if (!strcmp(branch
, "-"))
657 if (new_branch_force
) {
658 struct strbuf symref
= STRBUF_INIT
;
660 new_branch
= new_branch_force
;
663 !strbuf_check_branch_ref(&symref
, new_branch
) &&
664 ref_exists(symref
.buf
))
665 die_if_checked_out(symref
.buf
, 0);
666 strbuf_release(&symref
);
669 if (ac
< 2 && !new_branch
&& !opts
.detach
) {
670 const char *s
= dwim_branch(path
, &new_branch
);
675 if (ac
== 2 && !new_branch
&& !opts
.detach
) {
676 struct object_id oid
;
677 struct commit
*commit
;
680 commit
= lookup_commit_reference_by_name(branch
);
682 remote
= unique_tracking_name(branch
, &oid
, NULL
);
690 print_preparing_worktree_line(opts
.detach
, branch
, new_branch
, !!new_branch_force
);
693 struct child_process cp
= CHILD_PROCESS_INIT
;
695 strvec_push(&cp
.args
, "branch");
696 if (new_branch_force
)
697 strvec_push(&cp
.args
, "--force");
699 strvec_push(&cp
.args
, "--quiet");
700 strvec_push(&cp
.args
, new_branch
);
701 strvec_push(&cp
.args
, branch
);
703 strvec_push(&cp
.args
, opt_track
);
704 if (run_command(&cp
))
707 } else if (opt_track
) {
708 die(_("--[no-]track can only be used if a new branch is created"));
711 ret
= add_worktree(path
, branch
, &opts
);
716 static void show_worktree_porcelain(struct worktree
*wt
, int line_terminator
)
720 printf("worktree %s%c", wt
->path
, line_terminator
);
722 printf("bare%c", line_terminator
);
724 printf("HEAD %s%c", oid_to_hex(&wt
->head_oid
), line_terminator
);
726 printf("detached%c", line_terminator
);
727 else if (wt
->head_ref
)
728 printf("branch %s%c", wt
->head_ref
, line_terminator
);
731 reason
= worktree_lock_reason(wt
);
733 fputs("locked", stdout
);
736 write_name_quoted(reason
, stdout
, line_terminator
);
738 fputc(line_terminator
, stdout
);
742 reason
= worktree_prune_reason(wt
, expire
);
744 printf("prunable %s%c", reason
, line_terminator
);
746 fputc(line_terminator
, stdout
);
749 static void show_worktree(struct worktree
*wt
, int path_maxlen
, int abbrev_len
)
751 struct strbuf sb
= STRBUF_INIT
;
752 int cur_path_len
= strlen(wt
->path
);
753 int path_adj
= cur_path_len
- utf8_strwidth(wt
->path
);
756 strbuf_addf(&sb
, "%-*s ", 1 + path_maxlen
+ path_adj
, wt
->path
);
758 strbuf_addstr(&sb
, "(bare)");
760 strbuf_addf(&sb
, "%-*s ", abbrev_len
,
761 find_unique_abbrev(&wt
->head_oid
, DEFAULT_ABBREV
));
763 strbuf_addstr(&sb
, "(detached HEAD)");
764 else if (wt
->head_ref
) {
765 char *ref
= shorten_unambiguous_ref(wt
->head_ref
, 0);
766 strbuf_addf(&sb
, "[%s]", ref
);
769 strbuf_addstr(&sb
, "(error)");
772 reason
= worktree_lock_reason(wt
);
773 if (verbose
&& reason
&& *reason
)
774 strbuf_addf(&sb
, "\n\tlocked: %s", reason
);
776 strbuf_addstr(&sb
, " locked");
778 reason
= worktree_prune_reason(wt
, expire
);
779 if (verbose
&& reason
)
780 strbuf_addf(&sb
, "\n\tprunable: %s", reason
);
782 strbuf_addstr(&sb
, " prunable");
784 printf("%s\n", sb
.buf
);
788 static void measure_widths(struct worktree
**wt
, int *abbrev
, int *maxlen
)
792 for (i
= 0; wt
[i
]; i
++) {
794 int path_len
= strlen(wt
[i
]->path
);
796 if (path_len
> *maxlen
)
798 sha1_len
= strlen(find_unique_abbrev(&wt
[i
]->head_oid
, *abbrev
));
799 if (sha1_len
> *abbrev
)
804 static int pathcmp(const void *a_
, const void *b_
)
806 const struct worktree
*const *a
= a_
;
807 const struct worktree
*const *b
= b_
;
808 return fspathcmp((*a
)->path
, (*b
)->path
);
811 static void pathsort(struct worktree
**wt
)
814 struct worktree
**p
= wt
;
818 QSORT(wt
, n
, pathcmp
);
821 static int list(int ac
, const char **av
, const char *prefix
)
824 int line_terminator
= '\n';
826 struct option options
[] = {
827 OPT_BOOL(0, "porcelain", &porcelain
, N_("machine-readable output")),
828 OPT__VERBOSE(&verbose
, N_("show extended annotations and reasons, if available")),
829 OPT_EXPIRY_DATE(0, "expire", &expire
,
830 N_("add 'prunable' annotation to worktrees older than <time>")),
831 OPT_SET_INT('z', NULL
, &line_terminator
,
832 N_("terminate records with a NUL character"), '\0'),
837 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_list_usage
, 0);
839 usage_with_options(git_worktree_list_usage
, options
);
840 else if (verbose
&& porcelain
)
841 die(_("options '%s' and '%s' cannot be used together"), "--verbose", "--porcelain");
842 else if (!line_terminator
&& !porcelain
)
843 die(_("the option '%s' requires '%s'"), "-z", "--porcelain");
845 struct worktree
**worktrees
= get_worktrees();
846 int path_maxlen
= 0, abbrev
= DEFAULT_ABBREV
, i
;
848 /* sort worktrees by path but keep main worktree at top */
849 pathsort(worktrees
+ 1);
852 measure_widths(worktrees
, &abbrev
, &path_maxlen
);
854 for (i
= 0; worktrees
[i
]; i
++) {
856 show_worktree_porcelain(worktrees
[i
],
859 show_worktree(worktrees
[i
], path_maxlen
, abbrev
);
861 free_worktrees(worktrees
);
866 static int lock_worktree(int ac
, const char **av
, const char *prefix
)
868 const char *reason
= "", *old_reason
;
869 struct option options
[] = {
870 OPT_STRING(0, "reason", &reason
, N_("string"),
871 N_("reason for locking")),
874 struct worktree
**worktrees
, *wt
;
876 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_lock_usage
, 0);
878 usage_with_options(git_worktree_lock_usage
, options
);
880 worktrees
= get_worktrees();
881 wt
= find_worktree(worktrees
, prefix
, av
[0]);
883 die(_("'%s' is not a working tree"), av
[0]);
884 if (is_main_worktree(wt
))
885 die(_("The main working tree cannot be locked or unlocked"));
887 old_reason
= worktree_lock_reason(wt
);
890 die(_("'%s' is already locked, reason: %s"),
892 die(_("'%s' is already locked"), av
[0]);
895 write_file(git_common_path("worktrees/%s/locked", wt
->id
),
897 free_worktrees(worktrees
);
901 static int unlock_worktree(int ac
, const char **av
, const char *prefix
)
903 struct option options
[] = {
906 struct worktree
**worktrees
, *wt
;
909 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_unlock_usage
, 0);
911 usage_with_options(git_worktree_unlock_usage
, options
);
913 worktrees
= get_worktrees();
914 wt
= find_worktree(worktrees
, prefix
, av
[0]);
916 die(_("'%s' is not a working tree"), av
[0]);
917 if (is_main_worktree(wt
))
918 die(_("The main working tree cannot be locked or unlocked"));
919 if (!worktree_lock_reason(wt
))
920 die(_("'%s' is not locked"), av
[0]);
921 ret
= unlink_or_warn(git_common_path("worktrees/%s/locked", wt
->id
));
922 free_worktrees(worktrees
);
926 static void validate_no_submodules(const struct worktree
*wt
)
928 struct index_state istate
= INDEX_STATE_INIT(the_repository
);
929 struct strbuf path
= STRBUF_INIT
;
930 int i
, found_submodules
= 0;
932 if (is_directory(worktree_git_path(wt
, "modules"))) {
934 * There could be false positives, e.g. the "modules"
935 * directory exists but is empty. But it's a rare case and
936 * this simpler check is probably good enough for now.
938 found_submodules
= 1;
939 } else if (read_index_from(&istate
, worktree_git_path(wt
, "index"),
940 get_worktree_git_dir(wt
)) > 0) {
941 for (i
= 0; i
< istate
.cache_nr
; i
++) {
942 struct cache_entry
*ce
= istate
.cache
[i
];
945 if (!S_ISGITLINK(ce
->ce_mode
))
949 strbuf_addf(&path
, "%s/%s", wt
->path
, ce
->name
);
950 if (!is_submodule_populated_gently(path
.buf
, &err
))
953 found_submodules
= 1;
957 discard_index(&istate
);
958 strbuf_release(&path
);
960 if (found_submodules
)
961 die(_("working trees containing submodules cannot be moved or removed"));
964 static int move_worktree(int ac
, const char **av
, const char *prefix
)
967 struct option options
[] = {
969 N_("force move even if worktree is dirty or locked"),
970 PARSE_OPT_NOCOMPLETE
),
973 struct worktree
**worktrees
, *wt
;
974 struct strbuf dst
= STRBUF_INIT
;
975 struct strbuf errmsg
= STRBUF_INIT
;
976 const char *reason
= NULL
;
979 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_move_usage
,
982 usage_with_options(git_worktree_move_usage
, options
);
984 path
= prefix_filename(prefix
, av
[1]);
985 strbuf_addstr(&dst
, path
);
988 worktrees
= get_worktrees();
989 wt
= find_worktree(worktrees
, prefix
, av
[0]);
991 die(_("'%s' is not a working tree"), av
[0]);
992 if (is_main_worktree(wt
))
993 die(_("'%s' is a main working tree"), av
[0]);
994 if (is_directory(dst
.buf
)) {
995 const char *sep
= find_last_dir_sep(wt
->path
);
998 die(_("could not figure out destination name from '%s'"),
1000 strbuf_trim_trailing_dir_sep(&dst
);
1001 strbuf_addstr(&dst
, sep
);
1003 check_candidate_path(dst
.buf
, force
, worktrees
, "move");
1005 validate_no_submodules(wt
);
1008 reason
= worktree_lock_reason(wt
);
1011 die(_("cannot move a locked working tree, lock reason: %s\nuse 'move -f -f' to override or unlock first"),
1013 die(_("cannot move a locked working tree;\nuse 'move -f -f' to override or unlock first"));
1015 if (validate_worktree(wt
, &errmsg
, 0))
1016 die(_("validation failed, cannot move working tree: %s"),
1018 strbuf_release(&errmsg
);
1020 if (rename(wt
->path
, dst
.buf
) == -1)
1021 die_errno(_("failed to move '%s' to '%s'"), wt
->path
, dst
.buf
);
1023 update_worktree_location(wt
, dst
.buf
);
1025 strbuf_release(&dst
);
1026 free_worktrees(worktrees
);
1031 * Note, "git status --porcelain" is used to determine if it's safe to
1032 * delete a whole worktree. "git status" does not ignore user
1033 * configuration, so if a normal "git status" shows "clean" for the
1034 * user, then it's ok to remove it.
1036 * This assumption may be a bad one. We may want to ignore
1037 * (potentially bad) user settings and only delete a worktree when
1038 * it's absolutely safe to do so from _our_ point of view because we
1041 static void check_clean_worktree(struct worktree
*wt
,
1042 const char *original_path
)
1044 struct child_process cp
;
1049 * Until we sort this out, all submodules are "dirty" and
1050 * will abort this function.
1052 validate_no_submodules(wt
);
1054 child_process_init(&cp
);
1055 strvec_pushf(&cp
.env
, "%s=%s/.git",
1056 GIT_DIR_ENVIRONMENT
, wt
->path
);
1057 strvec_pushf(&cp
.env
, "%s=%s",
1058 GIT_WORK_TREE_ENVIRONMENT
, wt
->path
);
1059 strvec_pushl(&cp
.args
, "status",
1060 "--porcelain", "--ignore-submodules=none",
1065 ret
= start_command(&cp
);
1067 die_errno(_("failed to run 'git status' on '%s'"),
1069 ret
= xread(cp
.out
, buf
, sizeof(buf
));
1071 die(_("'%s' contains modified or untracked files, use --force to delete it"),
1074 ret
= finish_command(&cp
);
1076 die_errno(_("failed to run 'git status' on '%s', code %d"),
1077 original_path
, ret
);
1080 static int delete_git_work_tree(struct worktree
*wt
)
1082 struct strbuf sb
= STRBUF_INIT
;
1085 strbuf_addstr(&sb
, wt
->path
);
1086 if (remove_dir_recursively(&sb
, 0)) {
1087 error_errno(_("failed to delete '%s'"), sb
.buf
);
1090 strbuf_release(&sb
);
1094 static int remove_worktree(int ac
, const char **av
, const char *prefix
)
1097 struct option options
[] = {
1099 N_("force removal even if worktree is dirty or locked"),
1100 PARSE_OPT_NOCOMPLETE
),
1103 struct worktree
**worktrees
, *wt
;
1104 struct strbuf errmsg
= STRBUF_INIT
;
1105 const char *reason
= NULL
;
1108 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_remove_usage
, 0);
1110 usage_with_options(git_worktree_remove_usage
, options
);
1112 worktrees
= get_worktrees();
1113 wt
= find_worktree(worktrees
, prefix
, av
[0]);
1115 die(_("'%s' is not a working tree"), av
[0]);
1116 if (is_main_worktree(wt
))
1117 die(_("'%s' is a main working tree"), av
[0]);
1119 reason
= worktree_lock_reason(wt
);
1122 die(_("cannot remove a locked working tree, lock reason: %s\nuse 'remove -f -f' to override or unlock first"),
1124 die(_("cannot remove a locked working tree;\nuse 'remove -f -f' to override or unlock first"));
1126 if (validate_worktree(wt
, &errmsg
, WT_VALIDATE_WORKTREE_MISSING_OK
))
1127 die(_("validation failed, cannot remove working tree: %s"),
1129 strbuf_release(&errmsg
);
1131 if (file_exists(wt
->path
)) {
1133 check_clean_worktree(wt
, av
[0]);
1135 ret
|= delete_git_work_tree(wt
);
1138 * continue on even if ret is non-zero, there's no going back
1141 ret
|= delete_git_dir(wt
->id
);
1142 delete_worktrees_dir_if_empty();
1144 free_worktrees(worktrees
);
1148 static void report_repair(int iserr
, const char *path
, const char *msg
, void *cb_data
)
1151 fprintf_ln(stderr
, _("repair: %s: %s"), msg
, path
);
1153 int *exit_status
= (int *)cb_data
;
1154 fprintf_ln(stderr
, _("error: %s: %s"), msg
, path
);
1159 static int repair(int ac
, const char **av
, const char *prefix
)
1162 const char *self
[] = { ".", NULL
};
1163 struct option options
[] = {
1168 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_repair_usage
, 0);
1169 p
= ac
> 0 ? av
: self
;
1171 repair_worktree_at_path(*p
, report_repair
, &rc
);
1172 repair_worktrees(report_repair
, &rc
);
1176 int cmd_worktree(int ac
, const char **av
, const char *prefix
)
1178 parse_opt_subcommand_fn
*fn
= NULL
;
1179 struct option options
[] = {
1180 OPT_SUBCOMMAND("add", &fn
, add
),
1181 OPT_SUBCOMMAND("prune", &fn
, prune
),
1182 OPT_SUBCOMMAND("list", &fn
, list
),
1183 OPT_SUBCOMMAND("lock", &fn
, lock_worktree
),
1184 OPT_SUBCOMMAND("unlock", &fn
, unlock_worktree
),
1185 OPT_SUBCOMMAND("move", &fn
, move_worktree
),
1186 OPT_SUBCOMMAND("remove", &fn
, remove_worktree
),
1187 OPT_SUBCOMMAND("repair", &fn
, repair
),
1191 git_config(git_worktree_config
, NULL
);
1196 ac
= parse_options(ac
, av
, prefix
, options
, git_worktree_usage
, 0);
1197 return fn(ac
, av
, prefix
);